From 6704d8e98a6f310cb0dd5fc74a3f8b7937cda73b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:45 +0000 Subject: [PATCH 01/50] chore: update docs/dyn/index.md --- docs/dyn/index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index e84f527926..dc4fca983d 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -658,6 +658,10 @@ * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/firebaseapphosting_v1beta.html) +## firebasecrashlytics +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/firebasecrashlytics_v1alpha.html) + + ## firebasedatabase * [v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/firebasedatabase_v1beta.html) From afaf4fd47b727c33fd1a944d04f4a59b67821da4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:45 +0000 Subject: [PATCH 02/50] feat(accesscontextmanager): update the api #### accesscontextmanager:v1 The following keys were added: - schemas.AddRequestHeader (Total Keys: 4) - schemas.EgressSource.properties.pscEndpoint.$ref (Total Keys: 1) - schemas.IngressSource.properties.pscEndpoint.$ref (Total Keys: 1) - schemas.Modifier (Total Keys: 3) - schemas.PrivateServiceConnectEndpoint (Total Keys: 3) - schemas.ServicePattern (Total Keys: 6) - schemas.VpcAccessibleServices.properties.allowedServicePatterns (Total Keys: 2) - schemas.VpcAccessibleServices.properties.servicePatternsEnforcementScopes (Total Keys: 2) --- ...r_v1.accessPolicies.servicePerimeters.html | 230 ++++++++++++++++++ .../documents/accesscontextmanager.v1.json | 91 ++++++- 2 files changed, 320 insertions(+), 1 deletion(-) diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index 2d3d0d6ea5..9a657c7ddc 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -181,6 +181,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -220,6 +223,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -253,10 +259,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. # Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. @@ -274,6 +297,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -313,6 +339,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -346,10 +375,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "title": "A String", # Human readable title. Must be unique within the Policy. @@ -454,6 +500,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -493,6 +542,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -526,10 +578,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. # Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. @@ -547,6 +616,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -586,6 +658,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -619,10 +694,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "title": "A String", # Human readable title. Must be unique within the Policy. @@ -669,6 +761,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -708,6 +803,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -741,10 +839,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. # Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. @@ -762,6 +877,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -801,6 +919,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -834,10 +955,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "title": "A String", # Human readable title. Must be unique within the Policy. @@ -890,6 +1028,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -929,6 +1070,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -962,10 +1106,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. # Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. @@ -983,6 +1144,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -1022,6 +1186,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -1055,10 +1222,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "title": "A String", # Human readable title. Must be unique within the Policy. @@ -1127,6 +1311,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -1166,6 +1353,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -1199,10 +1389,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "status": { # `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. # Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. @@ -1220,6 +1427,9 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, ], @@ -1259,6 +1469,9 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, ], @@ -1292,10 +1505,27 @@

Method Details

"A String", ], "vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service Perimeter. # Configuration for APIs allowed within Perimeter. + "allowedServicePatterns": [ # Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter. + { # Service patterns used to allow access. + "modifiers": [ # Modifiers to apply to the requests that match the URL pattern. + { # Modifier to apply to the API requests. + "addRequestHeader": { # Adds a request header to the API. # Adds additional HTTP request headers. + "key": "A String", # HTTP header key. + "value": "A String", # HTTP header value. + }, + }, + ], + "pattern": "A String", # URL pattern to allow. Only patterns of ".googleapis.com/*", "www.googleapis.com//*" and "*.appspot.com/* forms are supported, where should be alphanumerical name. + "service": "A String", # Supported service to allow. + }, + ], "allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter. "A String", ], "enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + "servicePatternsEnforcementScopes": [ # Defines the enforcement scopes of service patterns. + "A String", + ], }, }, "title": "A String", # Human readable title. Must be unique within the Policy. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index b7b4c693a3..96488cc53e 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1331,7 +1331,7 @@ } } }, -"revision": "20260506", +"revision": "20260707", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1427,6 +1427,21 @@ }, "type": "object" }, +"AddRequestHeader": { +"description": "Adds a request header to the API.", +"id": "AddRequestHeader", +"properties": { +"key": { +"description": "HTTP header key.", +"type": "string" +}, +"value": { +"description": "HTTP header value.", +"type": "string" +} +}, +"type": "object" +}, "ApiOperation": { "description": "Identification for an API Operation.", "id": "ApiOperation", @@ -1859,6 +1874,10 @@ "description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" }, +"pscEndpoint": { +"$ref": "PrivateServiceConnectEndpoint", +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." +}, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", "type": "string" @@ -2070,6 +2089,10 @@ "description": "An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed.", "type": "string" }, +"pscEndpoint": { +"$ref": "PrivateServiceConnectEndpoint", +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." +}, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", "type": "string" @@ -2271,6 +2294,17 @@ }, "type": "object" }, +"Modifier": { +"description": "Modifier to apply to the API requests.", +"id": "Modifier", +"properties": { +"addRequestHeader": { +"$ref": "AddRequestHeader", +"description": "Adds additional HTTP request headers." +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -2374,6 +2408,17 @@ }, "type": "object" }, +"PrivateServiceConnectEndpoint": { +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", +"id": "PrivateServiceConnectEndpoint", +"properties": { +"forwardingRule": { +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"type": "string" +} +}, +"type": "object" +}, "ReplaceAccessLevelsRequest": { "description": "A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.", "id": "ReplaceAccessLevelsRequest", @@ -2457,6 +2502,28 @@ }, "type": "object" }, +"ServicePattern": { +"description": "Service patterns used to allow access.", +"id": "ServicePattern", +"properties": { +"modifiers": { +"description": "Modifiers to apply to the requests that match the URL pattern.", +"items": { +"$ref": "Modifier" +}, +"type": "array" +}, +"pattern": { +"description": "URL pattern to allow. Only patterns of \".googleapis.com/*\", \"www.googleapis.com//*\" and \"*.appspot.com/* forms are supported, where should be alphanumerical name.", +"type": "string" +}, +"service": { +"description": "Supported service to allow.", +"type": "string" +} +}, +"type": "object" +}, "ServicePerimeter": { "description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.", "id": "ServicePerimeter", @@ -2736,6 +2803,13 @@ "description": "Specifies how APIs are allowed to communicate within the Service Perimeter.", "id": "VpcAccessibleServices", "properties": { +"allowedServicePatterns": { +"description": "Specifies which Google services are allowed to be accessed from VPC networks in the service perimeter.", +"items": { +"$ref": "ServicePattern" +}, +"type": "array" +}, "allowedServices": { "description": "The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. You can specify a list of individual services, as well as include the 'RESTRICTED-SERVICES' value, which automatically includes all of the services protected by the perimeter.", "items": { @@ -2746,6 +2820,21 @@ "enableRestriction": { "description": "Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'.", "type": "boolean" +}, +"servicePatternsEnforcementScopes": { +"description": "Defines the enforcement scopes of service patterns.", +"items": { +"enum": [ +"SERVICE_PATTERNS_ENFORCEMENT_SCOPE_UNSPECIFIED", +"GOOGLE_APIS_VIA_PRIVATE_PATH" +], +"enumDescriptions": [ +"Default value. This can not be used.", +"Enables VPC Accessible Services enforcement for all APIs (including unsupported APIs) for Private Google Access configured with Private VIP and Private Service Connect Endpoint for Global Google APIs that uses 'all-apis' bundle." +], +"type": "string" +}, +"type": "array" } }, "type": "object" From 11ebd1d4065691d097b7ed6a626c3056061efea0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:45 +0000 Subject: [PATCH 03/50] feat(aiplatform): update the api #### aiplatform:v1 The following keys were added: - resources.memoryBanks.resources.memories.resources.operations.methods.cancel (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.delete (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.get (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.list (Total Keys: 20) - resources.memoryBanks.resources.memories.resources.operations.methods.wait (Total Keys: 14) - resources.memoryBanks.resources.operations.methods.cancel (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.delete (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.get (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.list (Total Keys: 20) - resources.memoryBanks.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.evaluationMetrics.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationMetrics.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.evaluationMetrics.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait (Total Keys: 14) - resources.tuningJobs.resources.operations.methods.wait (Total Keys: 14) - schemas.GoogleCloudAiplatformV1AgentData (Total Keys: 6) - schemas.GoogleCloudAiplatformV1AgentEvent (Total Keys: 10) - schemas.GoogleCloudAiplatformV1CandidateResponse.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1CandidateResult.properties.error (Total Keys: 2) - schemas.GoogleCloudAiplatformV1CloudLoggingConfig (Total Keys: 12) - schemas.GoogleCloudAiplatformV1ConversationTurn (Total Keys: 7) - schemas.GoogleCloudAiplatformV1EvaluationMetric (Total Keys: 14) - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.agentData.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.userScenario.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario (Total Keys: 4) - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.lossAnalysisConfig (Total Keys: 2) - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.agents (Total Keys: 2) - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.promptTemplate.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse (Total Keys: 5) - schemas.GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount (Total Keys: 2) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.buildSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableDataRetention.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableZeroDataRetention.type (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.logBuckets (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.observabilityBuckets (Total Keys: 2) The following keys were added: - resources.memoryBanks.resources.memories.methods.get (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.cancel (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.delete (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.get (Total Keys: 11) - resources.memoryBanks.resources.memories.resources.operations.methods.list (Total Keys: 20) - resources.memoryBanks.resources.memories.resources.operations.methods.wait (Total Keys: 14) - resources.memoryBanks.resources.operations.methods.cancel (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.delete (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.get (Total Keys: 11) - resources.memoryBanks.resources.operations.methods.list (Total Keys: 20) - resources.memoryBanks.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait (Total Keys: 14) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait (Total Keys: 14) - resources.tuningJobs.resources.operations.methods.cancel (Total Keys: 11) - resources.tuningJobs.resources.operations.methods.get (Total Keys: 11) - resources.tuningJobs.resources.operations.methods.wait (Total Keys: 14) - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies (Total Keys: 2) - schemas.GenaiVertexV1beta1GenerationConfig.properties.videoConfig.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ModelOutputStep.properties.error.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1ResponseFormat.properties.video.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1StepStop.properties.stepUsage.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1StepStop.properties.usage.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1Value.properties.contentValue.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1VideoConfig (Total Keys: 3) - schemas.GenaiVertexV1beta1VideoResponseFormat (Total Keys: 7) - schemas.GoogleCloudAiplatformV1beta1CandidateResult.properties.error (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig (Total Keys: 12) - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.publisherModelConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.promptTemplate.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadata (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.inputBucketProjectNumber (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.outputBucketProjectNumber (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.claudeFeatureConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.inferenceEventLoggingConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig (Total Keys: 5) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.buildSpec.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableDataRetention.deprecated (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableZeroDataRetention.type (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 9 +- docs/dyn/aiplatform_v1.html | 5 + docs/dyn/aiplatform_v1.memoryBanks.html | 96 + .../aiplatform_v1.memoryBanks.memories.html | 91 + ...rm_v1.memoryBanks.memories.operations.html | 272 + .../aiplatform_v1.memoryBanks.operations.html | 272 + ..._v1.projects.locations.cachedContents.html | 18 +- ...tform_v1.projects.locations.endpoints.html | 9 +- ...v1.projects.locations.evaluationItems.html | 14412 ++- ....projects.locations.evaluationMetrics.html | 1744 + ..._v1.projects.locations.evaluationRuns.html | 1260 +- ..._v1.projects.locations.evaluationSets.html | 21 +- .../dyn/aiplatform_v1.projects.locations.html | 1713 +- ...orm_v1.projects.locations.memoryBanks.html | 96 + ...ojects.locations.memoryBanks.memories.html | 143 + ...tions.memoryBanks.memories.operations.html | 272 + ...ects.locations.memoryBanks.operations.html | 272 + ....projects.locations.publishers.models.html | 9 +- ...1.projects.locations.reasoningEngines.html | 16 + ...s.locations.reasoningEngines.memories.html | 16 + ...jects.locations.tuningJobs.operations.html | 39 + docs/dyn/aiplatform_v1.publishers.models.html | 9 +- docs/dyn/aiplatform_v1.reasoningEngines.html | 16 + .../aiplatform_v1.tuningJobs.operations.html | 39 + docs/dyn/aiplatform_v1.v1.html | 15 +- docs/dyn/aiplatform_v1beta1.endpoints.html | 9 +- docs/dyn/aiplatform_v1beta1.html | 5 + docs/dyn/aiplatform_v1beta1.interactions.html | 80125 ++++++++------ docs/dyn/aiplatform_v1beta1.memoryBanks.html | 96 + ...platform_v1beta1.memoryBanks.memories.html | 150 + ...beta1.memoryBanks.memories.operations.html | 272 + ...atform_v1beta1.memoryBanks.operations.html | 272 + docs/dyn/aiplatform_v1beta1.projects.html | 14 + ...ta1.projects.locations.cachedContents.html | 18 +- ...m_v1beta1.projects.locations.datasets.html | 6 +- ..._v1beta1.projects.locations.endpoints.html | 129 +- ...a1.projects.locations.evaluationItems.html | 180 +- ...ta1.projects.locations.evaluationRuns.html | 196 +- ...ta1.projects.locations.evaluationSets.html | 21 +- ...aiplatform_v1beta1.projects.locations.html | 66 +- ...beta1.projects.locations.interactions.html | 91061 ++++++++++------ ...1beta1.projects.locations.memoryBanks.html | 96 + ...ojects.locations.memoryBanks.memories.html | 150 + ...tions.memoryBanks.memories.operations.html | 272 + ...ects.locations.memoryBanks.operations.html | 272 + ...ions.monitoredAgents.analyzedSessions.html | 2 +- ...a1.projects.locations.monitoredAgents.html | 12 - ....projects.locations.publishers.models.html | 23 +- ...1.projects.locations.reasoningEngines.html | 16 + ...s.locations.reasoningEngines.memories.html | 16 + ...ons.reasoningEngines.runtimeRevisions.html | 6 + ...v1beta1.projects.locations.tuningJobs.html | 2 + ...jects.locations.tuningJobs.operations.html | 98 + .../aiplatform_v1beta1.publishers.models.html | 9 +- .../aiplatform_v1beta1.reasoningEngines.html | 16 + ...orm_v1beta1.reasoningEngines.memories.html | 16 + ...latform_v1beta1.tuningJobs.operations.html | 98 + docs/dyn/aiplatform_v1beta1.v1beta1.html | 21 +- .../documents/aiplatform.v1.json | 2375 +- .../documents/aiplatform.v1beta1.json | 2939 +- 60 files changed, 130230 insertions(+), 69693 deletions(-) create mode 100644 docs/dyn/aiplatform_v1.memoryBanks.html create mode 100644 docs/dyn/aiplatform_v1.memoryBanks.memories.html create mode 100644 docs/dyn/aiplatform_v1.memoryBanks.memories.operations.html create mode 100644 docs/dyn/aiplatform_v1.memoryBanks.operations.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.operations.html create mode 100644 docs/dyn/aiplatform_v1.projects.locations.memoryBanks.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.memoryBanks.html create mode 100644 docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html create mode 100644 docs/dyn/aiplatform_v1beta1.memoryBanks.memories.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.memoryBanks.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.operations.html create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.operations.html diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index fd2b3c56d0..eb53bb10a0 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -668,7 +668,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1287,7 +1288,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2220,7 +2222,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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 a4068f89e1..aff6463c36 100644 --- a/docs/dyn/aiplatform_v1.html +++ b/docs/dyn/aiplatform_v1.html @@ -139,6 +139,11 @@

Instance Methods

Returns the media Resource.

+

+ memoryBanks() +

+

Returns the memoryBanks Resource.

+

metadataStores()

diff --git a/docs/dyn/aiplatform_v1.memoryBanks.html b/docs/dyn/aiplatform_v1.memoryBanks.html new file mode 100644 index 0000000000..64aefa6fca --- /dev/null +++ b/docs/dyn/aiplatform_v1.memoryBanks.html @@ -0,0 +1,96 @@ + + + +

Agent Platform API . memoryBanks

+

Instance Methods

+

+ memories() +

+

Returns the memories Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.memoryBanks.memories.html b/docs/dyn/aiplatform_v1.memoryBanks.memories.html new file mode 100644 index 0000000000..93524e96a4 --- /dev/null +++ b/docs/dyn/aiplatform_v1.memoryBanks.memories.html @@ -0,0 +1,91 @@ + + + +

Agent Platform API . memoryBanks . memories

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.memoryBanks.memories.operations.html b/docs/dyn/aiplatform_v1.memoryBanks.memories.operations.html new file mode 100644 index 0000000000..5610814fe9 --- /dev/null +++ b/docs/dyn/aiplatform_v1.memoryBanks.memories.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . memoryBanks . memories . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.memoryBanks.operations.html b/docs/dyn/aiplatform_v1.memoryBanks.operations.html new file mode 100644 index 0000000000..627ed4787a --- /dev/null +++ b/docs/dyn/aiplatform_v1.memoryBanks.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . memoryBanks . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ 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 7701ea3249..d686f998ac 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -421,7 +421,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -840,7 +841,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1284,7 +1286,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1714,7 +1717,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2152,7 +2156,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2572,7 +2577,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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 c0a621ff03..bb29f97b60 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -736,7 +736,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2251,7 +2252,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4666,7 +4668,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index d21c1b80c3..393286c4cf 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -123,6 +123,560 @@

Method Details

"evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate. "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -138,99 +692,4876 @@

Method Details

}, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. - "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. - "values": { # The values for fields in the prompt template. - "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], }, - "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. "a_key": "", # Properties of the object. }, - "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. + "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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. }, }, - }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation. + "candidateResults": [ # Optional. The results for the metric. + { # Result for a single candidate. + "additionalResults": "", # Optional. Additional results for the metric. + "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, + "explanation": "A String", # Optional. The explanation for the metric. + "metric": "A String", # Required. The metric that was evaluated. + "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. + { # Represents the verdict of an evaluation against a single rubric. + "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. + "labels": { # Optional. Labels for the EvaluationItem. + "a_key": "A String", + }, + "metadata": "", # Optional. Metadata for the EvaluationItem. + "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed. + "createTime": "A String", # Output only. Timestamp when this item was created. + "displayName": "A String", # Required. The display name of the EvaluationItem. + "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). # Output only. Error for the evaluation item. + "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. + }, + "evaluationItemType": "A String", # Required. The type of the EvaluationItem. + "evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. + "values": { # The values for fields in the prompt template. + "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. @@ -257,6 +5588,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -285,6 +5625,560 @@

Method Details

"request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -294,336 +6188,566 @@

Method Details

}, ], "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - ], - "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. - "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. - "values": { # The values for fields in the prompt template. - "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], }, - "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. "a_key": "", # Properties of the object. }, - "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. }, - "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. - "a_key": "", # Properties of the object. + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. + "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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. }, }, ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - }, - }, - "text": "A String", # Text prompt. - "value": "", # Fields and values that can be used to populate the prompt template. - }, - "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. - "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. - "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". - "groupId": "A String", # Unique identifier for the group. - "rubrics": [ # Rubrics that are part of this group. - { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. - "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. - "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. - "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." - }, - }, - "importance": "A String", # Optional. The relative importance of this rubric. - "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. - "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". - }, - ], - }, - }, - }, - }, - "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. - "labels": { # Optional. Labels for the EvaluationItem. - "a_key": "A String", - }, - "metadata": "", # Optional. Metadata for the EvaluationItem. - "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed. - "createTime": "A String", # Output only. Timestamp when this item was created. - "displayName": "A String", # Required. The display name of the EvaluationItem. - "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). # Output only. Error for the evaluation item. - "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. - }, - "evaluationItemType": "A String", # Required. The type of the EvaluationItem. - "evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate. - "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. - { # Responses from model or agent. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - ], - "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. - "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. - "values": { # The values for fields in the prompt template. - "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. - "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. - { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. - "outcome": "A String", # Required. Outcome of the code execution. - "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. - }, - "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. - "code": "A String", # Required. The code to be executed. - "language": "A String", # Required. Programming language of the `code`. - }, - "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. - "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. - "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. - "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. - { # Partial argument value of the function call. - "boolValue": True or False, # Optional. Represents a boolean value. - "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". - "nullValue": "A String", # Optional. Represents a null value. - "numberValue": 3.14, # Optional. Represents a double value. - "stringValue": "A String", # Optional. Represents a string value. - "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. - }, - ], - "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. - }, - "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. - "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. - "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. - "fileData": { # URI based data for function response. # URI based data. - "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, }, - "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. - "data": "A String", # Required. Raw bytes. - "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. }, }, ], - "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. "a_key": "", # Properties of the object. }, - "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. - }, - "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. - "data": "A String", # Required. The raw bytes of the data. - "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. - "level": "A String", # The tokenization quality used for given media. - }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. - }, - }, - }, - "text": "A String", # Text prompt. - "value": "", # Fields and values that can be used to populate the prompt template. - }, - "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. - "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. - "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". - "groupId": "A String", # Unique identifier for the group. - "rubrics": [ # Rubrics that are part of this group. - { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. - "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. - "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. - "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." - }, - }, - "importance": "A String", # Optional. The relative importance of this rubric. - "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. - "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". - }, - ], - }, - }, - }, - "evaluationResponse": { # Evaluation result. # Output only. The response from evaluation. - "candidateResults": [ # Optional. The results for the metric. - { # Result for a single candidate. - "additionalResults": "", # Optional. Additional results for the metric. - "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. - "explanation": "A String", # Optional. The explanation for the metric. - "metric": "A String", # Required. The metric that was evaluated. - "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. - { # Represents the verdict of an evaluation against a single rubric. - "evaluatedRubric": { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. # Required. The full rubric definition that was evaluated. Storing this ensures the verdict is self-contained and understandable, especially if the original rubric definition changes or was dynamically generated. - "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. - "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. - "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." }, - }, - "importance": "A String", # Optional. The relative importance of this rubric. - "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. - "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. }, - "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. - "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". - }, - ], - "score": 3.14, # Optional. The score for the metric. - }, - ], - "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} - "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} - "metadata": "", # Optional. Metadata about the evaluation result. - "metric": "A String", # Required. The metric that was evaluated. - "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. - "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. - { # Responses from model or agent. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. + ], }, - ], - "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -632,12 +6756,566 @@

Method Details

"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. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -702,117 +7380,675 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, - "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. - "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. - "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. - "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. - "startOffset": "A String", # Optional. The start offset of the video. + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + }, + }, + "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, + "value": "", # Fields and values that can be used to populate the prompt template. + }, + "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. + "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version. + "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task". + "groupId": "A String", # Unique identifier for the group. + "rubrics": [ # Rubrics that are part of this group. + { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics. + "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric. + "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. + "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." + }, + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + ], + }, + }, + }, + }, + "gcsUri": "A String", # The Cloud Storage object where the request or response is stored. + "labels": { # Optional. Labels for the EvaluationItem. + "a_key": "A String", + }, + "metadata": "", # Optional. Metadata for the EvaluationItem. + "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` +} + + +
+ delete(name, x__xgafv=None) +
Deletes an Evaluation Item.
+
+Args:
+  name: string, Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (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) +
Gets an Evaluation Item.
+
+Args:
+  name: string, Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
+  "createTime": "A String", # Output only. Timestamp when this item was created.
+  "displayName": "A String", # Required. The display name of the EvaluationItem.
+  "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). # Output only. Error for the evaluation item.
+    "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.
+  },
+  "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
+  "evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate.
+    "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
+      { # Responses from model or agent.
+        "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation.
+          "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.
+            "a_key": { # Represents configuration for an Agent.
+              "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.
+              "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent.
+              "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.
+              "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.
+              "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.
+                "A String",
+              ],
+              "tools": [ # Optional. The list of tools available to this agent.
+                { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                  "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                  },
+                  "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                    "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request.
+                    "environment": "A String", # Required. The environment being operated.
+                    "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                      "A String",
+                    ],
+                  },
+                  "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                    "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                    "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                      "A String",
+                    ],
+                  },
+                  "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation
+                    "apiKey": "A String", # Required. The API key for ExaAiSearch.
+                    "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
+                      "a_key": "", # Properties of the object.
+                    },
+                  },
+                  "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                    { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                      "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.
+                      "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                      "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                      "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                        "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                        "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                          # Object with schema name: GoogleCloudAiplatformV1Schema
+                        ],
+                        "default": "", # Optional. Default value to use if the field is not specified.
+                        "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                          "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                        },
+                        "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                        "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                          "A String",
+                        ],
+                        "example": "", # Optional. Example of an instance of this schema.
+                        "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                        "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                        "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                        "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                        "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                        "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                        "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                        "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                        "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                        "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                        "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                        "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                        "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                          "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                        },
+                        "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                          "A String",
+                        ],
+                        "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                        "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                          "A String",
+                        ],
+                        "title": "A String", # Optional. Title for the schema.
+                        "type": "A String", # Optional. Data type of the schema field.
+                      },
+                      "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                      "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                        "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                        "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                          # Object with schema name: GoogleCloudAiplatformV1Schema
+                        ],
+                        "default": "", # Optional. Default value to use if the field is not specified.
+                        "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                          "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                        },
+                        "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                        "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                          "A String",
+                        ],
+                        "example": "", # Optional. Example of an instance of this schema.
+                        "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                        "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                        "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                        "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                        "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                        "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                        "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                        "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                        "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                        "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                        "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                        "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                        "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                          "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                        },
+                        "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                          "A String",
+                        ],
+                        "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                        "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                          "A String",
+                        ],
+                        "title": "A String", # Optional. Title for the schema.
+                        "type": "A String", # Optional. Data type of the schema field.
+                      },
+                      "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                    },
+                  ],
+                  "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                    "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.
+                  },
+                  "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                    "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                    "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                      "A String",
+                    ],
+                    "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                      "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                      },
+                      "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                      },
+                    },
+                  },
+                  "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                    "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                      "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                      "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                    },
+                  },
+                  "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                    "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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.
+                    "enableZeroDataRetention": 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.
+                    "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                      "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                        "apiKeyConfig": { # The API secret. # The API secret.
+                          "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                          "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                        },
+                      },
+                      "apiSpec": "A String", # The API spec that the external API implements.
+                      "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                        "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                          "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                          "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                          "httpElementLocation": "A String", # Optional. The location of the API key.
+                          "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                        },
+                        "authType": "A String", # Type of auth scheme.
+                        "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                          "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                        },
+                        "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                          "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                        },
+                        "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                          "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                          "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                        },
+                        "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                          "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                          "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                        },
+                      },
+                      "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                        "index": "A String", # The ElasticSearch index to use.
+                        "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                        "searchTemplate": "A String", # The ElasticSearch search template to use.
+                      },
+                      "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                      "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                      },
+                    },
+                    "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                      "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                        { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                          "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                          "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                        },
+                      ],
+                      "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                      "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                      "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                      "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                    },
+                    "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                      "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                        { # The definition of the Rag resource.
+                          "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                          "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                            "A String",
+                          ],
+                        },
+                      ],
+                      "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                        "filter": { # Config for filters. # Optional. Config for filters.
+                          "metadataFilter": "A String", # Optional. String for metadata filtering.
+                          "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                          "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                        },
+                        "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                          "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                            "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                          },
+                          "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                            "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                          },
+                        },
+                        "topK": 42, # Optional. The number of contexts to retrieve.
+                      },
+                      "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                      "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                    },
+                  },
+                  "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                  },
+                },
+              ],
+            },
+          },
+          "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).
+            { # Represents a single turn/invocation in the conversation.
+              "events": [ # Optional. The list of events that occurred during this turn.
+                { # Represents a single event in the execution trace.
+                  "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.
+                    { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).
+                      "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation.
+                      },
+                      "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.
+                        "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request.
+                        "environment": "A String", # Required. The environment being operated.
+                        "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions.
+                          "A String",
+                        ],
+                      },
+                      "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains.
+                          "A String",
+                        ],
+                      },
+                      "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation
+                        "apiKey": "A String", # Required. The API key for ExaAiSearch.
+                        "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
+                          "a_key": "", # Properties of the object.
+                        },
+                      },
+                      "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.
+                        { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client.
+                          "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method.
+                          "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
+                          "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128.
+                          "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.
+                          "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.
+                            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                              # Object with schema name: GoogleCloudAiplatformV1Schema
+                            ],
+                            "default": "", # Optional. Default value to use if the field is not specified.
+                            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                            },
+                            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                              "A String",
+                            ],
+                            "example": "", # Optional. Example of an instance of this schema.
+                            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                            },
+                            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                              "A String",
+                            ],
+                            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                              "A String",
+                            ],
+                            "title": "A String", # Optional. Title for the schema.
+                            "type": "A String", # Optional. Data type of the schema field.
+                          },
+                          "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.
+                        },
+                      ],
+                      "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model.
+                        "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.
+                      },
+                      "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
+                        "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results.
+                        "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
+                          "A String",
+                        ],
+                        "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+                          "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+                          },
+                          "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+                          },
+                        },
+                      },
+                      "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
+                        "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
+                          "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.
+                          "mode": "A String", # The mode of the predictor to be used in dynamic retrieval.
+                        },
+                      },
+                      "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation
+                        "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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.
+                        "enableZeroDataRetention": 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.
+                        "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding.
+                          "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead.
+                            "apiKeyConfig": { # The API secret. # The API secret.
+                              "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+                              "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set.
+                            },
+                          },
+                          "apiSpec": "A String", # The API spec that the external API implements.
+                          "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API.
+                            "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth.
+                              "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                              "apiKeyString": "A String", # Optional. The API key to be used in the request directly.
+                              "httpElementLocation": "A String", # Optional. The location of the API key.
+                              "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name.
+                            },
+                            "authType": "A String", # Type of auth scheme.
+                            "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth.
+                              "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension.
+                            },
+                            "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth.
+                              "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource.
+                            },
+                            "oauthConfig": { # Config for user oauth. # Config for user oauth.
+                              "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account.
+                            },
+                            "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth.
+                              "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
+                              "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
+                            },
+                          },
+                          "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API.
+                            "index": "A String", # The ElasticSearch index to use.
+                            "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param.
+                            "searchTemplate": "A String", # The ElasticSearch search template to use.
+                          },
+                          "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search
+                          "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API.
+                          },
+                        },
+                        "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search.
+                          "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.
+                            { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+                              "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                              "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+                            },
+                          ],
+                          "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
+                          "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+                          "filter": "A String", # Optional. Filter strings to be passed to the search API.
+                          "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
+                        },
+                        "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.
+                          "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support.
+                            { # The definition of the Rag resource.
+                              "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+                              "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                                "A String",
+                              ],
+                            },
+                          ],
+                          "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+                            "filter": { # Config for filters. # Optional. Config for filters.
+                              "metadataFilter": "A String", # Optional. String for metadata filtering.
+                              "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+                              "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+                            },
+                            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+                              "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker.
+                                "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models).
+                              },
+                              "rankService": { # Config for Rank Service. # Optional. Config for Rank Service.
+                                "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`
+                              },
+                            },
+                            "topK": 42, # Optional. The number of contexts to retrieve.
+                          },
+                          "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora.
+                          "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+                        },
+                      },
+                      "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval.
+                      },
+                    },
+                  ],
+                  "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user.
+                  "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response).
+                    "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part.
+                      { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.
+                        "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode.
+                          "outcome": "A String", # Required. Outcome of the code execution.
+                          "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise.
+                        },
+                        "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed.
+                          "code": "A String", # Required. The code to be executed.
+                          "language": "A String", # Required. Programming language of the `code`.
+                        },
+                        "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage.
+                          "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                          "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function.
+                          "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name.
+                          "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally.
+                            { # Partial argument value of the function call.
+                              "boolValue": True or False, # Optional. Represents a boolean value.
+                              "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data".
+                              "nullValue": "A String", # Optional. Represents a null value.
+                              "numberValue": 3.14, # Optional. Represents a double value.
+                              "stringValue": "A String", # Optional. Represents a string value.
+                              "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow.
+                            },
+                          ],
+                          "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow.
+                        },
+                        "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted.
+                          "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.
+                          "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types.
+                            { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes.
+                              "fileData": { # URI based data for function response. # URI based data.
+                                "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                "fileUri": "A String", # Required. URI.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                              "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes.
+                                "data": "A String", # Required. Raw bytes.
+                                "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.
+                                "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                              },
+                            },
+                          ],
+                          "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.
+                        },
+                        "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request.
+                          "data": "A String", # Required. The raw bytes of the data.
+                          "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled.
+                          "mimeType": "A String", # Required. The IANA standard MIME type of the source data.
+                        },
+                        "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media.
+                          "level": "A String", # The tokenization quality used for given media.
+                        },
+                        "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.
+                        "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning.
+                        "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests.
+                        "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.
+                          "endOffset": "A String", # Optional. The end offset of the video.
+                          "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0].
+                          "startOffset": "A String", # Optional. The start offset of the video.
+                        },
+                      },
+                    ],
+                    "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
+                  },
+                  "eventTime": "A String", # Optional. The timestamp when the event occurred.
+                  "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.
+                    "a_key": "", # Properties of the object.
                   },
                 },
               ],
-              "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'.
-            },
-          },
-        },
-        "text": "A String", # Text prompt.
-        "value": "", # Fields and values that can be used to populate the prompt template.
-      },
-      "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group.
-        "a_key": { # A group of rubrics, used for grouping rubrics based on a metric or a version.
-          "displayName": "A String", # Human-readable name for the group. This should be unique within a given context if used for display or selection. Example: "Instruction Following V1", "Content Quality - Summarization Task".
-          "groupId": "A String", # Unique identifier for the group.
-          "rubrics": [ # Rubrics that are part of this group.
-            { # Message representing a single testable criterion for evaluation. One input prompt could have multiple rubrics.
-              "content": { # Content of the rubric, defining the testable criteria. # Required. The actual testable criteria for the rubric.
-                "property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property.
-                  "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct."
-                },
-              },
-              "importance": "A String", # Optional. The relative importance of this rubric.
-              "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict.
-              "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE".
+              "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.
+              "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence.
             },
           ],
         },
-      },
-    },
-  },
-  "gcsUri": "A String", # The Cloud Storage object where the request or response is stored.
-  "labels": { # Optional. Labels for the EvaluationItem.
-    "a_key": "A String",
-  },
-  "metadata": "", # Optional. Metadata for the EvaluationItem.
-  "name": "A String", # Identifier. The resource name of the EvaluationItem. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}`
-}
-
- -
- delete(name, x__xgafv=None) -
Deletes an Evaluation Item.
-
-Args:
-  name: string, Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (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) -
Gets an Evaluation Item.
-
-Args:
-  name: string, Required. The name of the EvaluationItem resource. Format: `projects/{project}/locations/{location}/evaluationItems/{evaluation_item}` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # EvaluationItem is a single evaluation request or result. The content of an EvaluationItem is immutable - it cannot be updated once created. EvaluationItems can be deleted when no longer needed.
-  "createTime": "A String", # Output only. Timestamp when this item was created.
-  "displayName": "A String", # Required. The display name of the EvaluationItem.
-  "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). # Output only. Error for the evaluation item.
-    "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.
-  },
-  "evaluationItemType": "A String", # Required. The type of the EvaluationItem.
-  "evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate.
-    "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison.
-      { # Responses from model or agent.
         "candidate": "A String", # Required. The name of the candidate that produced the response.
         "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). # Output only. Error while scraping model or agent.
           "code": 42, # The status code, which should be an enum value of google.rpc.Code.
@@ -826,8 +8062,562 @@ 

Method Details

"text": "A String", # Text response. "value": "", # Fields and values that can be used to populate the response template. }, - ], - "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -842,6 +8632,560 @@

Method Details

"value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -921,6 +9265,10 @@

Method Details

}, }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. @@ -947,6 +9295,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -956,40 +9313,1148 @@

Method Details

"property": { # Defines criteria based on a specific property. # Evaluation criteria based on a specific property. "description": "A String", # Description of the property being evaluated. Example: "The model's response is grammatically correct." }, - }, - "importance": "A String", # Optional. The relative importance of this rubric. - "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. - "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "importance": "A String", # Optional. The relative importance of this rubric. + "rubricId": "A String", # Unique identifier for the rubric. This ID is used to refer to this rubric, e.g., in RubricVerdict. + "type": "A String", # Optional. A type designator for the rubric, which can inform how it's evaluated or interpreted by systems or users. It's recommended to use consistent, well-defined, upper snake_case strings. Examples: "SUMMARIZATION_QUALITY", "SAFETY_HARMFUL_CONTENT", "INSTRUCTION_ADHERENCE". + }, + "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. + "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". + }, + ], + "score": 3.14, # Optional. The score for the metric. + }, + ], + "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} + "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} + "metadata": "", # Optional. Metadata about the evaluation result. + "metric": "A String", # Required. The metric that was evaluated. + "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. + "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. + { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, + "candidate": "A String", # Required. The name of the candidate that produced the response. + "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). # Output only. Error while scraping model or agent. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + ], + "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. }, - "reasoning": "A String", # Optional. Human-readable reasoning or explanation for the verdict. This can include specific examples or details from the evaluated content that justify the given verdict. - "verdict": True or False, # Required. Outcome of the evaluation against the rubric, represented as a boolean. `true` indicates a "Pass", `false` indicates a "Fail". - }, - ], - "score": 3.14, # Optional. The score for the metric. - }, - ], - "evaluationRequest": "A String", # Required. The request item that was evaluated. Format: projects/{project}/locations/{location}/evaluationItems/{evaluation_item} - "evaluationRun": "A String", # Required. The evaluation run that was used to generate the result. Format: projects/{project}/locations/{location}/evaluationRuns/{evaluation_run} - "metadata": "", # Optional. Metadata about the evaluation result. - "metric": "A String", # Required. The metric that was evaluated. - "request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. - "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. - { # Responses from model or agent. - "candidate": "A String", # Required. The name of the candidate that produced the response. - "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). # Output only. Error while scraping model or agent. - "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. - }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. + ], }, - ], - "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1004,6 +10469,560 @@

Method Details

"value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -1083,6 +11102,10 @@

Method Details

}, }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. @@ -1150,6 +11173,560 @@

Method Details

"evaluationRequest": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # The request to evaluate. "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1165,6 +11742,560 @@

Method Details

}, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1173,12 +12304,566 @@

Method Details

"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. + "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. + }, + "text": "A String", # Text response. + "value": "", # Fields and values that can be used to populate the response template. + }, + "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], }, - "text": "A String", # Text response. - "value": "", # Fields and values that can be used to populate the response template. - }, - "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -1258,6 +12943,10 @@

Method Details

}, }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. @@ -1284,6 +12973,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -1312,6 +13010,560 @@

Method Details

"request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1327,6 +13579,560 @@

Method Details

}, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -1341,6 +14147,560 @@

Method Details

"value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -1420,6 +14780,10 @@

Method Details

}, }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html new file mode 100644 index 0000000000..b853265a44 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html @@ -0,0 +1,1744 @@ + + + +

Agent Platform API . projects . locations . evaluationMetrics

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, evaluationMetricId=None, x__xgafv=None)

+

Creates an EvaluationMetric.

+

+ delete(name, x__xgafv=None)

+

Deletes an EvaluationMetric.

+

+ get(name, x__xgafv=None)

+

Gets an EvaluationMetric.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists EvaluationMetrics.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, evaluationMetricId=None, x__xgafv=None) +
Creates an EvaluationMetric.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # EvaluationMetric is a resource that represents a reusable metric configuration.
+  "createTime": "A String", # Output only. The time when the EvaluationMetric was created.
+  "description": "A String", # Optional. A description of the EvaluationMetric.
+  "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric.
+  "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification..
+  "labels": { # Optional. Labels for the evaluation metric.
+    "a_key": "A String",
+  },
+  "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported.
+    "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+      "A String",
+    ],
+    "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+      "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+    },
+    "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+      "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+        "a_key": "", # Properties of the object.
+      },
+      "type": "A String", # Required. The type of the computation based metric.
+    },
+    "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+      "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+    },
+    "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+    },
+    "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+      "additionalConfig": { # Optional. Optional additional configuration for the metric.
+        "a_key": "", # Properties of the object.
+      },
+      "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+            "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+          },
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+            { # Configuration for the model to configure output formatting and delivery.
+              "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "mimeType": "A String", # Optional. The MIME type of the audio output.
+                "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+              },
+              "image": { # Configuration for image-specific output formatting. # Image output format.
+                "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "imageSize": "A String", # Optional. The size of the image output.
+                "mimeType": "A String", # Optional. The MIME type of the image output.
+              },
+              "text": { # Configuration for text-specific output formatting. # Text output format.
+                "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+              },
+              "video": { # Configuration for video-specific output formatting. # Video output format.
+                "aspectRatio": "A String", # The aspect ratio for the video output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "duration": "A String", # Optional. The duration for the video output.
+                "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+              },
+            },
+          ],
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+            "A String",
+          ],
+          "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+              "modelRoutingPreference": "A String", # The model routing preference.
+            },
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+            },
+          },
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                { # Configuration for a single speaker in a multi-speaker setup.
+                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+              ],
+            },
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
+              },
+              "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+              },
+            },
+          },
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+            "A String",
+          ],
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+            "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+          },
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+        },
+        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+      },
+      "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+      "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+        "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+        "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result.
+        "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response.
+          "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation
+        },
+      },
+      "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+        "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+          "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+          "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+          "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+            "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+            "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+            "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+            "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+            "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+              "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+              "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                "compressionQuality": 42, # Optional. The compression quality of the output image.
+                "mimeType": "A String", # Optional. The image format that the output should be saved as.
+              },
+              "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+              "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+              "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+            },
+            "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+            "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+            "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+            "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+            "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+              { # Configuration for the model to configure output formatting and delivery.
+                "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                  "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "mimeType": "A String", # Optional. The MIME type of the audio output.
+                  "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+                },
+                "image": { # Configuration for image-specific output formatting. # Image output format.
+                  "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "imageSize": "A String", # Optional. The size of the image output.
+                  "mimeType": "A String", # Optional. The MIME type of the image output.
+                },
+                "text": { # Configuration for text-specific output formatting. # Text output format.
+                  "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                  "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+                },
+                "video": { # Configuration for video-specific output formatting. # Video output format.
+                  "aspectRatio": "A String", # The aspect ratio for the video output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "duration": "A String", # Optional. The duration for the video output.
+                  "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+                },
+              },
+            ],
+            "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+            "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+            "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+            "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+              "A String",
+            ],
+            "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+              "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+              "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                # Object with schema name: GoogleCloudAiplatformV1Schema
+              ],
+              "default": "", # Optional. Default value to use if the field is not specified.
+              "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+              "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                "A String",
+              ],
+              "example": "", # Optional. Example of an instance of this schema.
+              "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+              "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+              "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+              "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+              "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+              "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+              "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+              "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+              "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+              "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+              "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+              "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+              "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                "A String",
+              ],
+              "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+              "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                "A String",
+              ],
+              "title": "A String", # Optional. Title for the schema.
+              "type": "A String", # Optional. Data type of the schema field.
+            },
+            "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+              "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                "modelRoutingPreference": "A String", # The model routing preference.
+              },
+              "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+              },
+            },
+            "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+            "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+              "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+              "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                  { # Configuration for a single speaker in a multi-speaker setup.
+                    "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                    "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
+                      },
+                      "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                        "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                        "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                      },
+                    },
+                  },
+                ],
+              },
+              "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                  "voiceName": "A String", # The name of the prebuilt voice to use.
+                },
+                "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                  "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                  "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                },
+              },
+            },
+            "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+              "A String",
+            ],
+            "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+            "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+              "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+              "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+              "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+            },
+            "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+            "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+          },
+          "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+        },
+        "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+        "rubricContentType": "A String", # The type of rubric content to be generated.
+        "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+          "A String",
+        ],
+      },
+      "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+      "systemInstruction": "A String", # Optional. System instructions for the judge model.
+    },
+    "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+      "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+        "a_key": "", # Properties of the object.
+      },
+      "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+        "description": "A String", # Optional. The description of the score explaining the directionality etc.
+        "max": 3.14, # Required. The maximum value of the score range (inclusive).
+        "min": 3.14, # Required. The minimum value of the score range (inclusive).
+        "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+      },
+      "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+    },
+    "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+      "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+      "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+    },
+    "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+    },
+    "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+      "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+      "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+        "a_key": "", # Properties of the object.
+      },
+    },
+    "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+      "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+      "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+      "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
+  "updateTime": "A String", # Output only. The time when the EvaluationMetric was last updated.
+}
+
+  evaluationMetricId: string, Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationMetric is a resource that represents a reusable metric configuration.
+  "createTime": "A String", # Output only. The time when the EvaluationMetric was created.
+  "description": "A String", # Optional. A description of the EvaluationMetric.
+  "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric.
+  "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification..
+  "labels": { # Optional. Labels for the evaluation metric.
+    "a_key": "A String",
+  },
+  "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported.
+    "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+      "A String",
+    ],
+    "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+      "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+    },
+    "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+      "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+        "a_key": "", # Properties of the object.
+      },
+      "type": "A String", # Required. The type of the computation based metric.
+    },
+    "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+      "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+    },
+    "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+    },
+    "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+      "additionalConfig": { # Optional. Optional additional configuration for the metric.
+        "a_key": "", # Properties of the object.
+      },
+      "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+            "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+          },
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+            { # Configuration for the model to configure output formatting and delivery.
+              "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "mimeType": "A String", # Optional. The MIME type of the audio output.
+                "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+              },
+              "image": { # Configuration for image-specific output formatting. # Image output format.
+                "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "imageSize": "A String", # Optional. The size of the image output.
+                "mimeType": "A String", # Optional. The MIME type of the image output.
+              },
+              "text": { # Configuration for text-specific output formatting. # Text output format.
+                "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+              },
+              "video": { # Configuration for video-specific output formatting. # Video output format.
+                "aspectRatio": "A String", # The aspect ratio for the video output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "duration": "A String", # Optional. The duration for the video output.
+                "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+              },
+            },
+          ],
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+            "A String",
+          ],
+          "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+              "modelRoutingPreference": "A String", # The model routing preference.
+            },
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+            },
+          },
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                { # Configuration for a single speaker in a multi-speaker setup.
+                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+              ],
+            },
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
+              },
+              "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+              },
+            },
+          },
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+            "A String",
+          ],
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+            "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+          },
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+        },
+        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+      },
+      "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+      "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+        "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+        "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result.
+        "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response.
+          "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation
+        },
+      },
+      "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+        "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+          "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+          "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+          "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+            "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+            "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+            "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+            "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+            "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+              "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+              "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                "compressionQuality": 42, # Optional. The compression quality of the output image.
+                "mimeType": "A String", # Optional. The image format that the output should be saved as.
+              },
+              "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+              "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+              "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+            },
+            "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+            "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+            "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+            "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+            "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+              { # Configuration for the model to configure output formatting and delivery.
+                "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                  "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "mimeType": "A String", # Optional. The MIME type of the audio output.
+                  "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+                },
+                "image": { # Configuration for image-specific output formatting. # Image output format.
+                  "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "imageSize": "A String", # Optional. The size of the image output.
+                  "mimeType": "A String", # Optional. The MIME type of the image output.
+                },
+                "text": { # Configuration for text-specific output formatting. # Text output format.
+                  "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                  "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+                },
+                "video": { # Configuration for video-specific output formatting. # Video output format.
+                  "aspectRatio": "A String", # The aspect ratio for the video output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "duration": "A String", # Optional. The duration for the video output.
+                  "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+                },
+              },
+            ],
+            "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+            "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+            "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+            "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+              "A String",
+            ],
+            "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+              "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+              "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                # Object with schema name: GoogleCloudAiplatformV1Schema
+              ],
+              "default": "", # Optional. Default value to use if the field is not specified.
+              "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+              "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                "A String",
+              ],
+              "example": "", # Optional. Example of an instance of this schema.
+              "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+              "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+              "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+              "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+              "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+              "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+              "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+              "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+              "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+              "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+              "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+              "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+              "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                "A String",
+              ],
+              "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+              "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                "A String",
+              ],
+              "title": "A String", # Optional. Title for the schema.
+              "type": "A String", # Optional. Data type of the schema field.
+            },
+            "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+              "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                "modelRoutingPreference": "A String", # The model routing preference.
+              },
+              "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+              },
+            },
+            "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+            "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+              "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+              "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                  { # Configuration for a single speaker in a multi-speaker setup.
+                    "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                    "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
+                      },
+                      "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                        "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                        "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                      },
+                    },
+                  },
+                ],
+              },
+              "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                  "voiceName": "A String", # The name of the prebuilt voice to use.
+                },
+                "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                  "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                  "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                },
+              },
+            },
+            "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+              "A String",
+            ],
+            "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+            "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+              "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+              "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+              "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+            },
+            "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+            "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+          },
+          "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+        },
+        "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+        "rubricContentType": "A String", # The type of rubric content to be generated.
+        "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+          "A String",
+        ],
+      },
+      "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+      "systemInstruction": "A String", # Optional. System instructions for the judge model.
+    },
+    "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+      "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+        "a_key": "", # Properties of the object.
+      },
+      "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+        "description": "A String", # Optional. The description of the score explaining the directionality etc.
+        "max": 3.14, # Required. The maximum value of the score range (inclusive).
+        "min": 3.14, # Required. The minimum value of the score range (inclusive).
+        "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+      },
+      "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+    },
+    "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+      "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+      "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+    },
+    "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+    },
+    "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+      "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+      "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+        "a_key": "", # Properties of the object.
+      },
+    },
+    "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+      "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+      "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+      "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
+  "updateTime": "A String", # Output only. The time when the EvaluationMetric was last updated.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an EvaluationMetric.
+
+Args:
+  name: string, Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}` (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) +
Gets an EvaluationMetric.
+
+Args:
+  name: string, Required. The name of the EvaluationMetric resource. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # EvaluationMetric is a resource that represents a reusable metric configuration.
+  "createTime": "A String", # Output only. The time when the EvaluationMetric was created.
+  "description": "A String", # Optional. A description of the EvaluationMetric.
+  "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric.
+  "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification..
+  "labels": { # Optional. Labels for the evaluation metric.
+    "a_key": "A String",
+  },
+  "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported.
+    "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+      "A String",
+    ],
+    "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+      "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+    },
+    "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+      "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+        "a_key": "", # Properties of the object.
+      },
+      "type": "A String", # Required. The type of the computation based metric.
+    },
+    "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+      "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+    },
+    "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+    },
+    "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+      "additionalConfig": { # Optional. Optional additional configuration for the metric.
+        "a_key": "", # Properties of the object.
+      },
+      "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+        "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+        "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+        "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+          "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+          "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+          "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+          "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+          "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+            "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+            "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+              "compressionQuality": 42, # Optional. The compression quality of the output image.
+              "mimeType": "A String", # Optional. The image format that the output should be saved as.
+            },
+            "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+            "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+            "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+          },
+          "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+          "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+          "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+          "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+          "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+            { # Configuration for the model to configure output formatting and delivery.
+              "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "mimeType": "A String", # Optional. The MIME type of the audio output.
+                "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+              },
+              "image": { # Configuration for image-specific output formatting. # Image output format.
+                "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "imageSize": "A String", # Optional. The size of the image output.
+                "mimeType": "A String", # Optional. The MIME type of the image output.
+              },
+              "text": { # Configuration for text-specific output formatting. # Text output format.
+                "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+              },
+              "video": { # Configuration for video-specific output formatting. # Video output format.
+                "aspectRatio": "A String", # The aspect ratio for the video output.
+                "delivery": "A String", # Optional. Delivery mode for the generated content.
+                "duration": "A String", # Optional. The duration for the video output.
+                "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+              },
+            },
+          ],
+          "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+          "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+          "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+          "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+            "A String",
+          ],
+          "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+            "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+            "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+              # Object with schema name: GoogleCloudAiplatformV1Schema
+            ],
+            "default": "", # Optional. Default value to use if the field is not specified.
+            "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+            "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+              "A String",
+            ],
+            "example": "", # Optional. Example of an instance of this schema.
+            "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+            "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+            "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+            "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+            "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+            "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+            "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+            "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+            "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+            "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+            "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+            "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+            "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+              "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+            },
+            "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+              "A String",
+            ],
+            "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+            "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+              "A String",
+            ],
+            "title": "A String", # Optional. Title for the schema.
+            "type": "A String", # Optional. Data type of the schema field.
+          },
+          "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+            "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+              "modelRoutingPreference": "A String", # The model routing preference.
+            },
+            "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+              "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+            },
+          },
+          "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+          "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+            "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+            "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+              "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                { # Configuration for a single speaker in a multi-speaker setup.
+                  "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                  "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+              ],
+            },
+            "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+              "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                "voiceName": "A String", # The name of the prebuilt voice to use.
+              },
+              "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+              },
+            },
+          },
+          "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+            "A String",
+          ],
+          "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+          "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+            "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+            "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+            "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+          },
+          "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+          "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+        },
+        "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+      },
+      "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+      "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+        "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+        "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+          "a_key": "", # Properties of the object.
+        },
+      },
+      "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result.
+        "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response.
+          "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation
+        },
+      },
+      "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+        "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+          "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+          "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+          "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+            "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+            "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+            "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+            "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+            "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+              "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+              "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                "compressionQuality": 42, # Optional. The compression quality of the output image.
+                "mimeType": "A String", # Optional. The image format that the output should be saved as.
+              },
+              "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+              "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+              "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+            },
+            "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+            "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+            "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+            "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+            "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+              { # Configuration for the model to configure output formatting and delivery.
+                "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                  "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "mimeType": "A String", # Optional. The MIME type of the audio output.
+                  "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+                },
+                "image": { # Configuration for image-specific output formatting. # Image output format.
+                  "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "imageSize": "A String", # Optional. The size of the image output.
+                  "mimeType": "A String", # Optional. The MIME type of the image output.
+                },
+                "text": { # Configuration for text-specific output formatting. # Text output format.
+                  "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                  "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+                },
+                "video": { # Configuration for video-specific output formatting. # Video output format.
+                  "aspectRatio": "A String", # The aspect ratio for the video output.
+                  "delivery": "A String", # Optional. Delivery mode for the generated content.
+                  "duration": "A String", # Optional. The duration for the video output.
+                  "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+                },
+              },
+            ],
+            "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+            "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+            "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+            "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+              "A String",
+            ],
+            "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+              "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+              "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                # Object with schema name: GoogleCloudAiplatformV1Schema
+              ],
+              "default": "", # Optional. Default value to use if the field is not specified.
+              "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+              "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                "A String",
+              ],
+              "example": "", # Optional. Example of an instance of this schema.
+              "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+              "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+              "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+              "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+              "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+              "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+              "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+              "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+              "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+              "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+              "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+              "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+              "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+              },
+              "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                "A String",
+              ],
+              "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+              "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                "A String",
+              ],
+              "title": "A String", # Optional. Title for the schema.
+              "type": "A String", # Optional. Data type of the schema field.
+            },
+            "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+              "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                "modelRoutingPreference": "A String", # The model routing preference.
+              },
+              "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+              },
+            },
+            "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+            "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+              "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+              "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                  { # Configuration for a single speaker in a multi-speaker setup.
+                    "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                    "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                      "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                        "voiceName": "A String", # The name of the prebuilt voice to use.
+                      },
+                      "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                        "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                        "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                      },
+                    },
+                  },
+                ],
+              },
+              "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                  "voiceName": "A String", # The name of the prebuilt voice to use.
+                },
+                "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                  "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                  "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                },
+              },
+            },
+            "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+              "A String",
+            ],
+            "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+            "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+              "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+              "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+              "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+            },
+            "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+            "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+          },
+          "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+        },
+        "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+        "rubricContentType": "A String", # The type of rubric content to be generated.
+        "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+          "A String",
+        ],
+      },
+      "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+      "systemInstruction": "A String", # Optional. System instructions for the judge model.
+    },
+    "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+      "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+        "a_key": "", # Properties of the object.
+      },
+      "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+        "description": "A String", # Optional. The description of the score explaining the directionality etc.
+        "max": 3.14, # Required. The maximum value of the score range (inclusive).
+        "min": 3.14, # Required. The minimum value of the score range (inclusive).
+        "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+      },
+      "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+    },
+    "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+      "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+      "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+    },
+    "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+      "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+        "returnRawOutput": True or False, # Optional. Whether to return raw output.
+      },
+      "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+      "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+    },
+    "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+      "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+      "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+        "a_key": "", # Properties of the object.
+      },
+    },
+    "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+      "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+      "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+      "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+    },
+  },
+  "name": "A String", # Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
+  "updateTime": "A String", # Output only. The time when the EvaluationMetric was last updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists EvaluationMetrics.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.
+  pageSize: integer, Optional. The maximum number of EvaluationMetrics to return.
+  pageToken: string, Optional. A page token, received from a previous `ListEvaluationMetrics` 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 EvaluationMetricService.ListEvaluationMetrics.
+  "evaluationMetrics": [ # List of EvaluationMetrics in the requested page.
+    { # EvaluationMetric is a resource that represents a reusable metric configuration.
+      "createTime": "A String", # Output only. The time when the EvaluationMetric was created.
+      "description": "A String", # Optional. A description of the EvaluationMetric.
+      "displayName": "A String", # Required. The user-friendly display name for the EvaluationMetric.
+      "gcsUri": "A String", # Optional. The Google Cloud Storage URI that stores the metric specification..
+      "labels": { # Optional. Labels for the evaluation metric.
+        "a_key": "A String",
+      },
+      "metric": { # The metric used for running evaluations. # Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported.
+        "aggregationMetrics": [ # Optional. The aggregation metrics to use.
+          "A String",
+        ],
+        "bleuSpec": { # Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. # Spec for bleu metric.
+          "useEffectiveOrder": True or False, # Optional. Whether to use_effective_order to compute bleu score.
+        },
+        "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric.
+          "parameters": { # Optional. A map of parameters for the metric, e.g. {"rouge_type": "rougeL"}.
+            "a_key": "", # Properties of the object.
+          },
+          "type": "A String", # Required. The type of the computation based metric.
+        },
+        "customCodeExecutionSpec": { # Specificies a metric that is populated by evaluating user-defined Python code. # Spec for Custom Code Execution metric.
+          "evaluationFunction": "A String", # Required. Python function. Expected user to define the following function, e.g.: def evaluate(instance: dict[str, Any]) -> float: Please include this function signature in the code snippet. Instance is the evaluation instance, any fields populated in the instance are available to the function as instance[field_name]. Example: Example input: ``` instance= EvaluationInstance( response=EvaluationInstance.InstanceData(text="The answer is 4."), reference=EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` { 'response': {'text': 'The answer is 4.'}, 'reference': {'text': '4'} } ``` Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: if instance'response' == instance'reference': return 1.0 return 0.0 ``` CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) and Tuning Evaluation. Each line in the input jsonl file will be converted to dict[str, Any] and passed to the evaluation function.
+        },
+        "exactMatchSpec": { # Spec for exact match metric - returns 1 if prediction and reference exactly matches, otherwise 0. # Spec for exact match metric.
+        },
+        "llmBasedMetricSpec": { # Specification for an LLM based metric. # Spec for an LLM based metric.
+          "additionalConfig": { # Optional. Optional additional configuration for the metric.
+            "a_key": "", # Properties of the object.
+          },
+          "judgeAutoraterConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Optional. Optional configuration for the judge LLM (Autorater).
+            "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+            "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+            "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+              "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+              "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+              "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+              "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+              "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+                "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                  "compressionQuality": 42, # Optional. The compression quality of the output image.
+                  "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                },
+                "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+              },
+              "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+              "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+              "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+              "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+              "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+                { # Configuration for the model to configure output formatting and delivery.
+                  "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                    "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                    "delivery": "A String", # Optional. Delivery mode for the generated content.
+                    "mimeType": "A String", # Optional. The MIME type of the audio output.
+                    "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+                  },
+                  "image": { # Configuration for image-specific output formatting. # Image output format.
+                    "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                    "delivery": "A String", # Optional. Delivery mode for the generated content.
+                    "imageSize": "A String", # Optional. The size of the image output.
+                    "mimeType": "A String", # Optional. The MIME type of the image output.
+                  },
+                  "text": { # Configuration for text-specific output formatting. # Text output format.
+                    "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                    "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+                  },
+                  "video": { # Configuration for video-specific output formatting. # Video output format.
+                    "aspectRatio": "A String", # The aspect ratio for the video output.
+                    "delivery": "A String", # Optional. Delivery mode for the generated content.
+                    "duration": "A String", # Optional. The duration for the video output.
+                    "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+                  },
+                },
+              ],
+              "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+              "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+              "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+              "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                "A String",
+              ],
+              "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+                "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                  # Object with schema name: GoogleCloudAiplatformV1Schema
+                ],
+                "default": "", # Optional. Default value to use if the field is not specified.
+                "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                  "A String",
+                ],
+                "example": "", # Optional. Example of an instance of this schema.
+                "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                  "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                },
+                "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                  "A String",
+                ],
+                "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                  "A String",
+                ],
+                "title": "A String", # Optional. Title for the schema.
+                "type": "A String", # Optional. Data type of the schema field.
+              },
+              "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                  "modelRoutingPreference": "A String", # The model routing preference.
+                },
+                "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                  "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                },
+              },
+              "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+              "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                  "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                    { # Configuration for a single speaker in a multi-speaker setup.
+                      "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                      "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                        "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                          "voiceName": "A String", # The name of the prebuilt voice to use.
+                        },
+                        "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                          "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                          "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                  "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                    "voiceName": "A String", # The name of the prebuilt voice to use.
+                  },
+                  "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                    "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                    "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                  },
+                },
+              },
+              "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                "A String",
+              ],
+              "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+              "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+              },
+              "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+              "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+            },
+            "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+          },
+          "metricPromptTemplate": "A String", # Required. Template for the prompt sent to the judge model.
+          "predefinedRubricGenerationSpec": { # The spec for a pre-defined metric. # Dynamically generate rubrics using a predefined spec.
+            "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+            "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+              "a_key": "", # Properties of the object.
+            },
+          },
+          "resultParserConfig": { # Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. # Optional. The parser config for the metric result.
+            "customCodeParserConfig": { # Configuration for parsing the LLM response using custom code. # Optional. Use custom code to parse the LLM response.
+              "parsingFunction": "A String", # Required. Python function for parsing results. The function should be defined within this string. The function takes a list of strings (LLM responses) and should return either a list of dictionaries (for rubrics) or a single dictionary (for a metric result). Example function signature: def parse(responses: list[str]) -> list[dict[str, Any]] | dict[str, Any]: When parsing rubrics, return a list of dictionaries, where each dictionary represents a Rubric. Example for rubrics: [ { "content": {"property": {"description": "The response is factual."}}, "type": "FACTUALITY", "importance": "HIGH" }, { "content": {"property": {"description": "The response is fluent."}}, "type": "FLUENCY", "importance": "MEDIUM" } ] When parsing critique results, return a dictionary representing a MetricResult. Example for a metric result: { "score": 0.8, "explanation": "The model followed most instructions.", "rubric_verdicts": [...] } ... code for result extraction and aggregation
+            },
+          },
+          "rubricGenerationSpec": { # Specification for how rubrics should be generated. # Dynamically generate rubrics using this specification.
+            "modelConfig": { # The configs for autorater. This is applicable to both EvaluateInstances and EvaluateDataset. # Configuration for the model used in rubric generation. Configs including sampling count and base model can be specified here. Flipping is not supported for rubric generation.
+              "autoraterModel": "A String", # Optional. The fully qualified name of the publisher model or tuned autorater endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
+              "flipEnabled": True or False, # Optional. Default is true. Whether to flip the candidate and baseline responses. This is only applicable to the pairwise metric. If enabled, also provide PairwiseMetricSpec.candidate_response_field_name and PairwiseMetricSpec.baseline_response_field_name. When rendering PairwiseMetricSpec.metric_prompt_template, the candidate and baseline fields will be flipped for half of the samples to reduce bias.
+              "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Configuration options for model generation and outputs.
+                "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response.
+                "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one.
+                "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response.
+                "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+                "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead.
+                  "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9"
+                  "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images.
+                    "compressionQuality": 42, # Optional. The compression quality of the output image.
+                    "mimeType": "A String", # Optional. The image format that the output should be saved as.
+                  },
+                  "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+                  "personGeneration": "A String", # Optional. Controls whether the model can generate people.
+                  "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people.
+                },
+                "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response.
+                "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses.
+                "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model.
+                "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+                "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery.
+                  { # Configuration for the model to configure output formatting and delivery.
+                    "audio": { # Configuration for audio-specific output formatting. # Audio output format.
+                      "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+                      "delivery": "A String", # Optional. Delivery mode for the generated content.
+                      "mimeType": "A String", # Optional. The MIME type of the audio output.
+                      "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz.
+                    },
+                    "image": { # Configuration for image-specific output formatting. # Image output format.
+                      "aspectRatio": "A String", # Optional. The aspect ratio for the image output.
+                      "delivery": "A String", # Optional. Delivery mode for the generated content.
+                      "imageSize": "A String", # Optional. The size of the image output.
+                      "mimeType": "A String", # Optional. The MIME type of the image output.
+                    },
+                    "text": { # Configuration for text-specific output formatting. # Text output format.
+                      "mimeType": "A String", # Optional. The IANA standard MIME type of the response.
+                      "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.
+                    },
+                    "video": { # Configuration for video-specific output formatting. # Video output format.
+                      "aspectRatio": "A String", # The aspect ratio for the video output.
+                      "delivery": "A String", # Optional. Delivery mode for the generated content.
+                      "duration": "A String", # Optional. The duration for the video output.
+                      "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.
+                    },
+                  },
+                ],
+                "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.
+                "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging.
+                "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead.
+                "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image.
+                  "A String",
+                ],
+                "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead.
+                  "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema.
+                  "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`.
+                    # Object with schema name: GoogleCloudAiplatformV1Schema
+                  ],
+                  "default": "", # Optional. Default value to use if the field is not specified.
+                  "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
+                  "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
+                    "A String",
+                  ],
+                  "example": "", # Optional. Example of an instance of this schema.
+                  "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type.
+                  "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array.
+                  "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array.
+                  "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string.
+                  "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided.
+                  "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value.
+                  "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array.
+                  "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string.
+                  "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided.
+                  "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value.
+                  "nullable": True or False, # Optional. Indicates if the value of this field can be null.
+                  "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match.
+                  "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object.
+                    "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema
+                  },
+                  "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties.
+                    "A String",
+                  ],
+                  "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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
+                  "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present.
+                    "A String",
+                  ],
+                  "title": "A String", # Optional. Title for the schema.
+                  "type": "A String", # Optional. Data type of the schema field.
+                },
+                "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration.
+                  "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request.
+                    "modelRoutingPreference": "A String", # The model routing preference.
+                  },
+                  "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually.
+                    "modelName": "A String", # The name of the model to use. Only public LLM models are accepted.
+                  },
+                },
+                "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results.
+                "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config.
+                  "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis.
+                  "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`.
+                    "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided.
+                      { # Configuration for a single speaker in a multi-speaker setup.
+                        "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt.
+                        "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker.
+                          "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                            "voiceName": "A String", # The name of the prebuilt voice to use.
+                          },
+                          "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                            "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                            "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                          },
+                        },
+                      },
+                    ],
+                  },
+                  "voiceConfig": { # Configuration for a voice. # The configuration for the voice to use.
+                    "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice.
+                      "voiceName": "A String", # The name of the prebuilt voice to use.
+                    },
+                    "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample.
+                      "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set.
+                      "voiceSampleAudio": "A String", # Optional. The sample of the custom voice.
+                    },
+                  },
+                },
+                "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker.
+                  "A String",
+                ],
+                "temperature": 3.14, # Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0].
+                "thinkingConfig": { # Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. # Optional. Configuration for thinking features. An error will be returned if this field is set for models that don't support thinking.
+                  "includeThoughts": True or False, # Optional. If true, the model will include its thoughts in the response. "Thoughts" are the intermediate steps the model takes to arrive at the final response. They can provide insights into the model's reasoning process and help with debugging. If this is true, thoughts are returned only when available.
+                  "thinkingBudget": 42, # Optional. The token budget for the model's thinking process. The model will make a best effort to stay within this budget. This can be used to control the trade-off between response quality and latency.
+                  "thinkingLevel": "A String", # Optional. The number of thoughts tokens that the model should generate.
+                },
+                "topK": 3.14, # Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a `top_k` of 40 means the model will choose the next word from the 40 most likely words.
+                "topP": 3.14, # Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least `top_p`. This helps generate more diverse and less repetitive responses. For example, a `top_p` of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or `top_p`, but not both.
+              },
+              "samplingCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32.
+            },
+            "promptTemplate": "A String", # Template for the prompt used to generate rubrics. The details should be updated based on the most-recent recipe requirements.
+            "rubricContentType": "A String", # The type of rubric content to be generated.
+            "rubricTypeOntology": [ # Optional. An optional, pre-defined list of allowed types for generated rubrics. If this field is provided, it implies `include_rubric_type` should be true, and the generated rubric types should be chosen from this ontology.
+              "A String",
+            ],
+          },
+          "rubricGroupKey": "A String", # Use a pre-defined group of rubrics associated with the input. Refers to a key in the rubric_groups map of EvaluationInstance.
+          "systemInstruction": "A String", # Optional. System instructions for the judge model.
+        },
+        "metadata": { # Metadata about the metric, used for visualization and organization. # Optional. Metadata about the metric, used for visualization and organization.
+          "otherMetadata": { # Optional. Flexible metadata for user-defined attributes.
+            "a_key": "", # Properties of the object.
+          },
+          "scoreRange": { # The range of possible scores for this metric, used for plotting. # Optional. The range of possible scores for this metric, used for plotting.
+            "description": "A String", # Optional. The description of the score explaining the directionality etc.
+            "max": 3.14, # Required. The maximum value of the score range (inclusive).
+            "min": 3.14, # Required. The minimum value of the score range (inclusive).
+            "step": 3.14, # Optional. The distance between discrete steps in the range. If unset, the range is assumed to be continuous.
+          },
+          "title": "A String", # Optional. The user-friendly name for the metric. If not set for a registered metric, it will default to the metric's display name.
+        },
+        "pairwiseMetricSpec": { # Spec for pairwise metric. # Spec for pairwise metric.
+          "baselineResponseFieldName": "A String", # Optional. The field name of the baseline response.
+          "candidateResponseFieldName": "A String", # Optional. The field name of the candidate response.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. When this config is set, the default output is replaced with the raw output string. If a custom format is chosen, the `pairwise_choice` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pairwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pairwise metric.
+        },
+        "pointwiseMetricSpec": { # Spec for pointwise metric. # Spec for pointwise metric.
+          "customOutputFormatConfig": { # Spec for custom output format configuration. # Optional. CustomOutputFormatConfig allows customization of metric output. By default, metrics return a score and explanation. When this config is set, the default output is replaced with either: - The raw output string. - A parsed output based on a user-defined schema. If a custom format is chosen, the `score` and `explanation` fields in the corresponding metric result will be empty.
+            "returnRawOutput": True or False, # Optional. Whether to return raw output.
+          },
+          "metricPromptTemplate": "A String", # Required. Metric prompt template for pointwise metric.
+          "systemInstruction": "A String", # Optional. System instructions for pointwise metric.
+        },
+        "predefinedMetricSpec": { # The spec for a pre-defined metric. # The spec for a pre-defined metric.
+          "metricSpecName": "A String", # Required. The name of a pre-defined metric, such as "instruction_following_v1" or "text_quality_v1".
+          "metricSpecParameters": { # Optional. The parameters needed to run the pre-defined metric.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rougeSpec": { # Spec for rouge score metric - calculates the recall of n-grams in prediction as compared to reference - returns a score ranging between 0 and 1. # Spec for rouge metric.
+          "rougeType": "A String", # Optional. Supported rouge types are rougen[1-9], rougeL, and rougeLsum.
+          "splitSummaries": True or False, # Optional. Whether to split summaries while using rougeLsum.
+          "useStemmer": True or False, # Optional. Whether to use stemmer to compute rouge score.
+        },
+      },
+      "name": "A String", # Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`
+      "updateTime": "A String", # Output only. The time when the EvaluationMetric was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results.
+}
+
+ +
+ 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 75cde2d646..9f867fadb4 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -307,12 +307,30 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -1666,6 +1684,243 @@

Method Details

"modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, }, + "agents": { # Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. @@ -1807,6 +2062,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -1998,12 +2257,30 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -3357,120 +3634,357 @@

Method Details

"modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, }, - "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. - "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. - "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. - "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. - "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead. - "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" - "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. - "compressionQuality": 42, # Optional. The compression quality of the output image. - "mimeType": "A String", # Optional. The image format that the output should be saved as. - }, - "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - "personGeneration": "A String", # Optional. Controls whether the model can generate people. - "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. - }, - "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. - "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. - "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. - "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery. - { # Configuration for the model to configure output formatting and delivery. - "audio": { # Configuration for audio-specific output formatting. # Audio output format. - "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # Optional. Delivery mode for the generated content. - "mimeType": "A String", # Optional. The MIME type of the audio output. - "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz. - }, - "image": { # Configuration for image-specific output formatting. # Image output format. - "aspectRatio": "A String", # Optional. The aspect ratio for the image output. - "delivery": "A String", # Optional. Delivery mode for the generated content. - "imageSize": "A String", # Optional. The size of the image output. - "mimeType": "A String", # Optional. The MIME type of the image output. - }, - "text": { # Configuration for text-specific output formatting. # Text output format. - "mimeType": "A String", # Optional. The IANA standard MIME type of the response. - "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. - }, - "video": { # Configuration for video-specific output formatting. # Video output format. - "aspectRatio": "A String", # The aspect ratio for the video output. - "delivery": "A String", # Optional. Delivery mode for the generated content. - "duration": "A String", # Optional. The duration for the video output. - "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. - }, - }, - ], - "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead. - "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. - "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. - "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. - "A String", - ], - "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead. - "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. - "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. - # Object with schema name: GoogleCloudAiplatformV1Schema - ], - "default": "", # Optional. Default value to use if the field is not specified. - "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. - "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` - "A String", - ], - "example": "", # Optional. Example of an instance of this schema. - "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. - "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. - "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. - "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. - "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. - "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. - "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. - "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. - "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. - "nullable": True or False, # Optional. Indicates if the value of this field can be null. - "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. - "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. - "A String", - ], - "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 - "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "agents": { # Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. "A String", ], - "title": "A String", # Optional. Title for the schema. - "type": "A String", # Optional. Data type of the schema field. - }, - "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. - "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. - "modelRoutingPreference": "A String", # The model routing preference. - }, - "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. - "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. - }, - }, - "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. - "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. - "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. - "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. - "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. - { # Configuration for a single speaker in a multi-speaker setup. - "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. - "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. - "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. - "voiceName": "A String", # The name of the prebuilt voice to use. - }, - "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. - "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. - "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. - }, - }, + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. + "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. + "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. + "enableAffectiveDialog": True or False, # Optional. If enabled, the model will detect emotions and adapt its responses accordingly. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. + "frequencyPenalty": 3.14, # Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. # Optional. Config for image generation features. Deprecated: Use `response_format.image` instead. + "aspectRatio": "A String", # Optional. The desired aspect ratio for the generated images. The following aspect ratios are supported: "1:1" "2:3", "3:2" "3:4", "4:3" "4:5", "5:4" "9:16", "16:9" "21:9" + "imageOutputOptions": { # The image output format for generated images. # Optional. The image output format for generated images. + "compressionQuality": 42, # Optional. The compression quality of the output image. + "mimeType": "A String", # Optional. The image format that the output should be saved as. + }, + "imageSize": "A String", # Optional. Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + "personGeneration": "A String", # Optional. Controls whether the model can generate people. + "prominentPeople": "A String", # Optional. Controls whether prominent people (celebrities) generation is allowed. If used with personGeneration, personGeneration enum would take precedence. For instance, if ALLOW_NONE is set, all person generation would be blocked. If this field is unspecified, the default behavior is to allow prominent people. + }, + "logprobs": 42, # Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. + "maxOutputTokens": 42, # Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. + "mediaResolution": "A String", # Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. + "presencePenalty": 3.14, # Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "responseFormat": [ # Optional. New response format field for the model to configure output formatting and delivery. + { # Configuration for the model to configure output formatting and delivery. + "audio": { # Configuration for audio-specific output formatting. # Audio output format. + "bitRate": 42, # Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # Optional. Delivery mode for the generated content. + "mimeType": "A String", # Optional. The MIME type of the audio output. + "sampleRate": 42, # Optional. Sample rate for the generated audio in Hertz. + }, + "image": { # Configuration for image-specific output formatting. # Image output format. + "aspectRatio": "A String", # Optional. The aspect ratio for the image output. + "delivery": "A String", # Optional. Delivery mode for the generated content. + "imageSize": "A String", # Optional. The size of the image output. + "mimeType": "A String", # Optional. The MIME type of the image output. + }, + "text": { # Configuration for text-specific output formatting. # Text output format. + "mimeType": "A String", # Optional. The IANA standard MIME type of the response. + "schema": "", # Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. + }, + "video": { # Configuration for video-specific output formatting. # Video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # Optional. Delivery mode for the generated content. + "duration": "A String", # Optional. The duration for the video output. + "gcsUri": "A String", # Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. + }, + }, + ], + "responseJsonSchema": "", # Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead. + "responseLogprobs": True or False, # Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. + "responseMimeType": "A String", # Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' (default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use `response_format` instead. + "responseModalities": [ # Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to `[TEXT, IMAGE]`, the response will include both text and an image. + "A String", + ], + "responseSchema": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Lets you to specify a schema for the model's response, ensuring that the output conforms to a particular structure. This is useful for generating structured data such as JSON. The schema is a subset of the [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema) object. When this field is set, you must also set the `response_mime_type` to `application/json`. Deprecated: Use `response_format` instead. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "routingConfig": { # The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. # Optional. Routing configuration. + "autoMode": { # The configuration for automated routing. When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # In this mode, the model is selected automatically based on the content of the request. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # The configuration for manual routing. When manual routing is specified, the model will be selected based on the model name provided. # In this mode, the model is specified manually. + "modelName": "A String", # The name of the model to use. Only public LLM models are accepted. + }, + }, + "seed": 42, # Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like `temperature`, which control the *level* of randomness. `seed` ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. + "speechConfig": { # Configuration for speech generation. # Optional. The speech generation config. + "languageCode": "A String", # Optional. The language code (ISO 639-1) for the speech synthesis. + "multiSpeakerVoiceConfig": { # Configuration for a multi-speaker text-to-speech request. # The configuration for a multi-speaker text-to-speech request. This field is mutually exclusive with `voice_config`. + "speakerVoiceConfigs": [ # Required. A list of configurations for the voices of the speakers. Exactly two speaker voice configurations must be provided. + { # Configuration for a single speaker in a multi-speaker setup. + "speaker": "A String", # Required. The name of the speaker. This should be the same as the speaker name used in the prompt. + "voiceConfig": { # Configuration for a voice. # Required. The configuration for the voice of this speaker. + "prebuiltVoiceConfig": { # Configuration for a prebuilt voice. # The configuration for a prebuilt voice. + "voiceName": "A String", # The name of the prebuilt voice to use. + }, + "replicatedVoiceConfig": { # The configuration for the replicated voice to use. # Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample. + "mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. + "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. + }, + }, }, ], }, @@ -3498,6 +4012,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -3731,12 +4249,30 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -5090,6 +5626,243 @@

Method Details

"modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, }, + "agents": { # Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. @@ -5231,6 +6004,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -5435,12 +6212,30 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } "displayName": "A String", # Optional. A display name for this custom summary metric. Used to prefix keys in the output summaryMetrics map. If not provided, a default name like "dataset_custom_metric_1", "dataset_custom_metric_2", etc., will be generated based on the order in the repeated field. }, ], + "lossAnalysisConfig": [ # Optional. Specifications for loss analysis. Each config can be specified for one metric. + { # Configuration for the loss analysis job. + "candidate": "A String", # Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + "metric": "A String", # Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + }, + ], "metrics": [ # Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. { # The metric used for evaluation runs. "computationBasedMetricSpec": { # Specification for a computation based metric. # Spec for a computation based metric. @@ -6794,6 +7589,243 @@

Method Details

"modelName": "A String", # The model name to use for multi-turn agent scraping to get next user message, e.g. "gemini-3-flash-preview". }, }, + "agents": { # Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, "generationConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation config. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "candidateCount": 42, # Optional. The number of candidate responses to generate. A higher `candidate_count` can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. @@ -6935,6 +7967,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html index a87310d996..9df98be642 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html @@ -259,7 +259,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -514,7 +515,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -811,7 +813,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1099,7 +1102,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1413,7 +1417,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1687,7 +1692,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1943,7 +1949,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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 3323ba7d7d..f410629cb6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -119,6 +119,11 @@

Instance Methods

Returns the evaluationItems Resource.

+

+ evaluationMetrics() +

+

Returns the evaluationMetrics Resource.

+

evaluationRuns()

@@ -159,6 +164,11 @@

Instance Methods

Returns the indexes Resource.

+

+ memoryBanks() +

+

Returns the memoryBanks Resource.

+

metadataStores()

@@ -510,7 +520,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -796,7 +807,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2532,7 +2544,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2850,7 +2863,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3239,7 +3253,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3470,7 +3485,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -5740,7 +5756,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6117,6 +6134,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -6145,6 +6171,560 @@

Method Details

"request": { # A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. # Required. The request that was evaluated. "candidateResponses": [ # Optional. Responses from model under test and other baseline models for comparison. { # Responses from model or agent. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -6160,6 +6740,560 @@

Method Details

}, ], "goldenResponse": { # Responses from model or agent. # Optional. The Ideal response or ground truth. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "candidate": "A String", # Required. The name of the candidate that produced the response. "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). # Output only. Error while scraping model or agent. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -6174,6 +7308,560 @@

Method Details

"value": "", # Fields and values that can be used to populate the response template. }, "prompt": { # Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. # Optional. The request/prompt to evaluate. + "agentData": { # Represents data specific to multi-turn agent evaluations. # Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "a_key": { # Represents configuration for an Agent. + "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + "description": "A String", # Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + "instruction": "A String", # Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field. + "subAgents": [ # Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + "A String", + ], + "tools": [ # Optional. The list of tools available to this agent. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + }, + }, + "turns": [ # Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response). + { # Represents a single turn/invocation in the conversation. + "events": [ # Optional. The list of events that occurred during this turn. + { # Represents a single event in the execution trace. + "activeTools": [ # Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. + }, + "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. + "environment": "A String", # Required. The environment being operated. + "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. + "A String", + ], + }, + "enterpriseWebSearch": { # Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. # Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. + "A String", + ], + }, + "exaAiSearch": { # ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. # Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + "apiKey": "A String", # Required. The API key for ExaAiSearch. + "customConfigs": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name, description, parameters and response type. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "behavior": "A String", # Optional. Specifies the function Behavior. If not specified, the system keeps the current function call behavior. This field is currently only supported by the BidiGenerateContent method. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, colons and dashes, with a maximum length of 128. + "parameters": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "parametersJsonSchema": "", # Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`. + "response": { # Defines the schema of input and output data. This is a subset of the [OpenAPI 3.0 Schema Object](https://spec.openapis.org/oas/v3.0.3#schema-object). # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "additionalProperties": "", # Optional. If `type` is `OBJECT`, specifies how to handle properties not defined in `properties`. If it is a boolean `false`, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. + "anyOf": [ # Optional. The instance must be valid against any (one or more) of the subschemas listed in `any_of`. + # Object with schema name: GoogleCloudAiplatformV1Schema + ], + "default": "", # Optional. Default value to use if the field is not specified. + "defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. + "enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}` + "A String", + ], + "example": "", # Optional. Example of an instance of this schema. + "format": "A String", # Optional. The format of the data. For `NUMBER` type, format can be `float` or `double`. For `INTEGER` type, format can be `int32` or `int64`. For `STRING` type, format can be `email`, `byte`, `date`, `date-time`, `password`, and other formats to further refine the data type. + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. If type is `ARRAY`, `items` specifies the schema of elements in the array. + "maxItems": "A String", # Optional. If type is `ARRAY`, `max_items` specifies the maximum number of items in an array. + "maxLength": "A String", # Optional. If type is `STRING`, `max_length` specifies the maximum length of the string. + "maxProperties": "A String", # Optional. If type is `OBJECT`, `max_properties` specifies the maximum number of properties that can be provided. + "maximum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `maximum` specifies the maximum allowed value. + "minItems": "A String", # Optional. If type is `ARRAY`, `min_items` specifies the minimum number of items in an array. + "minLength": "A String", # Optional. If type is `STRING`, `min_length` specifies the minimum length of the string. + "minProperties": "A String", # Optional. If type is `OBJECT`, `min_properties` specifies the minimum number of properties that can be provided. + "minimum": 3.14, # Optional. If type is `INTEGER` or `NUMBER`, `minimum` specifies the minimum allowed value. + "nullable": True or False, # Optional. Indicates if the value of this field can be null. + "pattern": "A String", # Optional. If type is `STRING`, `pattern` specifies a regular expression that the string must match. + "properties": { # Optional. If type is `OBJECT`, `properties` is a map of property names to schema definitions for each property of the object. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "propertyOrdering": [ # Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. + "A String", + ], + "ref": "A String", # Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in `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 + "required": [ # Optional. If type is `OBJECT`, `required` lists the names of properties that must be present. + "A String", + ], + "title": "A String", # Optional. Title for the schema. + "type": "A String", # Optional. Data type of the schema field. + }, + "responseJsonSchema": "", # Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`. + }, + ], + "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. + "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. + }, + "googleSearch": { # GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. # Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. + "blockingConfidence": "A String", # Optional. Sites with confidence level chosen & above this value will be blocked from the search results. + "excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. + "A String", + ], + "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default. + "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned. + }, + "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned. + }, + }, + }, + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search. + "dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source. + "dynamicThreshold": 3.14, # Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + "mode": "A String", # The mode of the predictor to be used in dynamic retrieval. + }, + }, + "parallelAiSearch": { # ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. # Optional. If specified, Vertex AI will use Parallel.ai to search for information to answer user queries. The search results will be grounded on Parallel.ai and presented to the model for response generation + "apiKey": "A String", # Optional. The API key for ParallelAiSearch. If an API key is not provided, the system will attempt to verify access by checking for an active Parallel.ai subscription through the Google Cloud Marketplace. See https://docs.parallel.ai/search/search-quickstart for more 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. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. + "externalApi": { # Retrieve from data source powered by external API for grounding. The external API is not owned by Google, but need to follow the pre-defined API spec. # Use data source powered by external API for grounding. + "apiAuth": { # The generic reusable api auth config. Deprecated. Please use AuthConfig (google/cloud/aiplatform/master/auth.proto) instead. # The authentication config to access the API. Deprecated. Please use auth_config instead. + "apiKeyConfig": { # The API secret. # The API secret. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + "apiKeyString": "A String", # The API key string. Either this or `api_key_secret_version` must be set. + }, + }, + "apiSpec": "A String", # The API spec that the external API implements. + "authConfig": { # Auth configuration to run the extension. # The authentication config to access the API. + "apiKeyConfig": { # Config for authentication with API key. # Config for API key auth. + "apiKeySecret": "A String", # Optional. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If both `api_key_secret` and `api_key_string` are specified, this field takes precedence over `api_key_string`. - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + "apiKeyString": "A String", # Optional. The API key to be used in the request directly. + "httpElementLocation": "A String", # Optional. The location of the API key. + "name": "A String", # Optional. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key=", "api_key" would be the parameter name. + }, + "authType": "A String", # Type of auth scheme. + "googleServiceAccountConfig": { # Config for Google Service Account Authentication. # Config for Google Service Account auth. + "serviceAccount": "A String", # Optional. The service account that the extension execution service runs as. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified service account. - If not specified, the Vertex AI Extension Service Agent will be used to execute the Extension. + }, + "httpBasicAuthConfig": { # Config for HTTP Basic Authentication. # Config for HTTP Basic auth. + "credentialSecret": "A String", # Required. The name of the SecretManager secret version resource storing the base64 encoded credentials. Format: `projects/{project}/secrets/{secrete}/versions/{version}` - If specified, the `secretmanager.versions.access` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the specified resource. + }, + "oauthConfig": { # Config for user oauth. # Config for user oauth. + "accessToken": "A String", # Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate access tokens for executing the Extension. - If the service account is specified, the `iam.serviceAccounts.getAccessToken` permission should be granted to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) on the provided service account. + }, + "oidcConfig": { # Config for user OIDC auth. # Config for user OIDC auth. + "idToken": "A String", # OpenID Connect formatted ID token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time. + "serviceAccount": "A String", # The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc). - The audience for the token will be set to the URL in the server url defined in the OpenApi spec. - If the service account is provided, the service account should grant `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). + }, + }, + "elasticSearchParams": { # The search parameters to use for the ELASTIC_SEARCH spec. # Parameters for the elastic search API. + "index": "A String", # The ElasticSearch index to use. + "numHits": 42, # Optional. Number of hits (chunks) to request. When specified, it is passed to Elasticsearch as the `num_hits` param. + "searchTemplate": "A String", # The ElasticSearch search template to use. + }, + "endpoint": "A String", # The endpoint of the external API. The system will call the API at this endpoint to retrieve the data for grounding. Example: https://acme.com:443/search + "simpleSearchParams": { # The search parameters to use for SIMPLE_SEARCH spec. # Parameters for the simple search API. + }, + }, + "vertexAiSearch": { # Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder # Set to use data source powered by Vertex AI Search. + "dataStoreSpecs": [ # Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used. + { # Define data stores within engine to filter on in a search call and configurations for those data stores. For more information, see https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec + "dataStore": "A String", # Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "filter": "A String", # Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + }, + ], + "datastore": "A String", # Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` + "engine": "A String", # Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` + "filter": "A String", # Optional. Filter strings to be passed to the search API. + "maxResults": 42, # Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10. + }, + "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "ragRetrievalConfig": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadataFilter": "A String", # Optional. String for metadata filtering. + "vectorDistanceThreshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vectorSimilarityThreshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "llmRanker": { # Config for LlmRanker. # Optional. Config for LlmRanker. + "modelName": "A String", # Optional. The model name used for ranking. See [Supported models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference#supported-models). + }, + "rankService": { # Config for Rank Service. # Optional. Config for Rank Service. + "modelName": "A String", # Optional. The model name of the rank service. Format: `semantic-ranker-512@latest` + }, + }, + "topK": 42, # Optional. The number of contexts to retrieve. + }, + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + "urlContext": { # Tool to support URL context. # Optional. Tool to support URL context retrieval. + }, + }, + ], + "author": "A String", # Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + "content": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. # Required. The content of the event (e.g., text response, tool call, tool response). + "parts": [ # Required. A list of Part objects that make up a single message. Parts of a message can have different MIME types. A Content message must have at least one Part. + { # A datatype containing media that is part of a multi-part Content message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. For media types that are not text, `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "codeExecutionResult": { # Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. # Optional. The result of executing the ExecutableCode. + "outcome": "A String", # Required. Outcome of the code execution. + "output": "A String", # Optional. Contains stdout when code execution is successful, stderr or other description otherwise. + }, + "executableCode": { # Code generated by the model that is meant to be executed, and the result returned to the model. Generated when using the `CodeExecution` tool, in which the code will be automatically executed, and a corresponding CodeExecutionResult will also be generated. # Optional. Code generated by the model that is intended to be executed. + "code": "A String", # Required. The code to be executed. + "language": "A String", # Required. Programming language of the `code`. + }, + "fileData": { # URI-based data. A FileData message contains a URI pointing to data of a specific media type. It is used to represent images, audio, and video stored in Google Cloud Storage. # Optional. The URI-based data of the part. This can be used to include files from Google Cloud Storage. + "displayName": "A String", # Optional. The display name of the file. Used to provide a label or filename to distinguish files. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "fileUri": "A String", # Required. The URI of the file in Google Cloud Storage. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name and a structured JSON object containing the parameters and their values. # Optional. A predicted function call returned from the model. This contains the name of the function to call and the arguments to pass to the function. + "args": { # Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Optional. The name of the function to call. Matches FunctionDeclaration.name. + "partialArgs": [ # Optional. The partial argument value of the function call. If provided, represents the arguments/fields that are streamed incrementally. + { # Partial argument value of the function call. + "boolValue": True or False, # Optional. Represents a boolean value. + "jsonPath": "A String", # Required. A JSON Path (RFC 9535) to the argument being streamed. https://datatracker.ietf.org/doc/html/rfc9535. e.g. "$.foo.bar[0].data". + "nullValue": "A String", # Optional. Represents a null value. + "numberValue": 3.14, # Optional. Represents a double value. + "stringValue": "A String", # Optional. Represents a string value. + "willContinue": True or False, # Optional. Whether this is not the last part of the same json_path. If true, another PartialArg message for the current json_path is expected to follow. + }, + ], + "willContinue": True or False, # Optional. Whether this is the last part of the FunctionCall. If true, another partial message for the current FunctionCall is expected to follow. + }, + "functionResponse": { # The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. # Optional. The result of a function call. This is used to provide the model with the result of a function call that it predicted. + "name": "A String", # Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. + "parts": [ # Optional. Ordered `Parts` that constitute a function response. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a `FunctionResponse` message. A `FunctionResponsePart` consists of data which has an associated datatype. A `FunctionResponsePart` can only contain one of the accepted types in `FunctionResponsePart.data`. A `FunctionResponsePart` must have a fixed IANA MIME type identifying the type and subtype of the media if the `inline_data` field is filled with raw bytes. + "fileData": { # URI based data for function response. # URI based data. + "displayName": "A String", # Optional. Display name of the file data. Used to provide a label or filename to distinguish file datas. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "inlineData": { # Raw media bytes for function response. Text should not be sent as raw bytes, use the 'text' field. # Inline media bytes. + "data": "A String", # Required. Raw bytes. + "displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + }, + ], + "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. + "a_key": "", # Properties of the object. + }, + "scheduling": "A String", # Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE. + }, + "inlineData": { # A content blob. A Blob contains data of a specific media type. It is used to represent images, audio, and video. # Optional. The inline data content of the part. This can be used to include images, audio, or video in a request. + "data": "A String", # Required. The raw bytes of the data. + "displayName": "A String", # Optional. The display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in `PromptMessage` for prompt management. It is used in the Gemini calls only when server-side tools (`code_execution`, `google_search`, and `url_context`) are enabled. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. + "level": "A String", # The tokenization quality used for given media. + }, + "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. + "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. + "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. + "videoMetadata": { # Provides metadata for a video, including the start and end offsets for clipping and the frame rate. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "fps": 3.14, # Optional. The frame rate of the video sent to the model. If not specified, the default value is 1.0. The valid range is (0.0, 24.0]. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. If not set, the service will default to 'user'. + }, + "eventTime": "A String", # Optional. The timestamp when the event occurred. + "stateDelta": { # Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + "a_key": "", # Properties of the object. + }, + }, + ], + "turnId": "A String", # Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + "turnIndex": 42, # Required. The 0-based index of the turn in the conversation sequence. + }, + ], + }, "promptTemplateData": { # Message to hold a prompt template and the values to populate the template. # Prompt template data. "values": { # The values for fields in the prompt template. "a_key": { # The structured data content of a message. A Content message contains a `role` field, which indicates the producer of the content, and a `parts` field, which contains the multi-part data of the message. @@ -6253,6 +7941,10 @@

Method Details

}, }, "text": "A String", # Text prompt. + "userScenario": { # User scenario to help simulate multi-turn agent running results. # Optional. The generated user scenario used to drive multi-turn agent running results. + "conversationPlan": "A String", # Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + "startingPrompt": "A String", # Required. The prompt that starts the conversation between the simulated user and the agent under test. + }, "value": "", # Fields and values that can be used to populate the prompt template. }, "rubrics": { # Optional. Named groups of rubrics associated with this prompt. The key is a user-defined name for the rubric group. @@ -6519,7 +8211,7 @@

Method Details

The object takes the form of: { # Request message for DataFoundryService.GenerateUserScenarios. - "agents": { # Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent. "a_key": { # Represents configuration for an Agent. "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. @@ -6664,7 +8356,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6756,7 +8449,7 @@

Method Details

}, }, "allowCrossRegionModel": True or False, # Optional. Allows the scenario generation to use cross region models. When this flag is set, the service may route traffic to other regions if a model is unavailable in the current region (e.g., to a `global` endpoint). If a fully-qualified model endpoint resource name with a different region than the request location is provided elsewhere in the request, this flag must be set to true or the request will fail. - "rootAgentId": "A String", # Required. The agent id to identify the root agent. + "rootAgentId": "A String", # Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent. "userScenarioGenerationConfig": { # User scenario generation configuration. # Required. Configuration for generating user scenarios. "environmentData": "A String", # Optional. Environment data in string type. "modelName": "A String", # Optional. The model name to use for generation. It can be model name, e.g. "gemini-3-pro-preview". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html new file mode 100644 index 0000000000..869428ee88 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html @@ -0,0 +1,96 @@ + + + +

Agent Platform API . projects . locations . memoryBanks

+

Instance Methods

+

+ memories() +

+

Returns the memories Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html new file mode 100644 index 0000000000..880a6ad4d4 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html @@ -0,0 +1,143 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.operations.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.operations.html new file mode 100644 index 0000000000..f7830c0bf0 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.operations.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.operations.html new file mode 100644 index 0000000000..297420b2a1 --- /dev/null +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index faf263ea05..1361cff7ef 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -675,7 +675,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1443,7 +1444,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2604,7 +2606,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 826016cca8..58f1da2464 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -365,6 +365,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -396,6 +397,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -751,6 +755,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -782,6 +787,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1068,6 +1076,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1099,6 +1108,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1355,6 +1367,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1386,6 +1399,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 75509ee8de..13986f9825 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -539,14 +539,30 @@

Method Details

}, ], }, + "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`. "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately. "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, + "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. + "a_key": { # Memory metadata. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. + }, + }, + "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. + "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html index b889e0b157..d87dbfa0a1 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.operations.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Method Details

cancel(name, x__xgafv=None) @@ -230,4 +233,40 @@

Method Details

+
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index fe9b4f1082..a98662c0c5 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -661,7 +661,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1280,7 +1281,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2788,7 +2790,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 849f30348c..ebbc32290c 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -355,6 +355,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -386,6 +387,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -742,6 +746,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -773,6 +778,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1024,6 +1032,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1055,6 +1064,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1311,6 +1323,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1342,6 +1355,9 @@

Method Details

"name": "A String", # Identifier. The resource name of the ReasoningEngine. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` "spec": { # ReasoningEngine configurations # Optional. Configurations of the ReasoningEngine "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1.tuningJobs.operations.html b/docs/dyn/aiplatform_v1.tuningJobs.operations.html index 6b32a39296..793700b700 100644 --- a/docs/dyn/aiplatform_v1.tuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1.tuningJobs.operations.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Method Details

cancel(name, x__xgafv=None) @@ -230,4 +233,40 @@

Method Details

+
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index a0f48c755e..7855c7078d 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -1113,7 +1113,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1431,7 +1432,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1820,7 +1822,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2051,7 +2054,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4320,7 +4324,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 3f009c581b..f79766bb44 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -677,7 +677,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1310,7 +1311,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2264,7 +2266,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.html b/docs/dyn/aiplatform_v1beta1.html index 85a75c6fa9..527e81986b 100644 --- a/docs/dyn/aiplatform_v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.html @@ -199,6 +199,11 @@

Instance Methods

Returns the media Resource.

+

+ memoryBanks() +

+

Returns the memoryBanks Resource.

+

metadataStores()

diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index d7bd4dc286..afba08120f 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -117,6 +117,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -156,25 +458,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -217,25 +501,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -276,25 +542,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -314,25 +562,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -372,25 +602,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -424,25 +636,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -488,25 +682,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -540,25 +716,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -604,25 +762,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -665,25 +805,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -724,25 +846,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -762,25 +866,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -820,25 +906,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -872,25 +940,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -936,25 +986,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -988,25 +1020,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -1066,6 +1080,9 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, "model": "A String", # The name of the `Model` used for generating the completion. }, @@ -1094,25 +1111,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1155,25 +1154,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1214,25 +1195,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -1252,25 +1215,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -1310,25 +1255,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1362,25 +1289,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -1426,25 +1335,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1478,25 +1369,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -1542,6 +1415,308 @@

Method Details

}, "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -1573,338 +1748,61 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -1917,25 +1815,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1966,284 +1846,268 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "fileSearchCall": { # File Search content. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "searchType": "A String", # The type of search grounding enabled. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, @@ -2259,257 +2123,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -2521,201 +2291,339 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + }, + ], }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -2727,18 +2635,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -2751,25 +2663,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2800,189 +2694,125 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -2994,892 +2824,154 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "fileSearchCall": { # File Search content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. + ], + "text": "A String", # Required. The text content. + }, }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + ], }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "functionResult": { # A function tool result content block. + "mcpServerToolResult": { # MCPServer tool result content. "contentList": { "contents": [ { @@ -3894,25 +2986,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -3943,152 +3017,18 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, @@ -4100,128 +3040,247 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "contentString": "A String", # The content of the step. A single string. - }, + ], }, - ], + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -4233,229 +3292,435 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "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. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4467,25 +3732,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -4513,400 +3760,307 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4918,25 +4072,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -4964,408 +4100,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -5377,343 +4268,333 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -5725,266 +4606,308 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + "text": "A String", # Required. The text content. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -5996,326 +4919,189 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "widgetContextToken": "A String", }, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -6328,25 +5114,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -6377,868 +5145,523 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", ], }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, -} - - -
- close() -
Close httplib2 connections.
-
- -
- getPoll(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) -
Fully typed proto, unary version of GetInteraction that returns Interaction proto.
-
-Args:
-  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
-  includeInput: boolean, Optional. If true, includes the input in the response.
-  lastEventId: string, Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
-  stream: boolean, Optional. If true, streams the interaction events as Server-Sent Events.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for InteractionService.CreateInteraction.
-  "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents.
-    "agent": "A String", # The name of the `Agent` used for generating the completion.
-    "deepResearchConfig": { # Configuration for the Deep Research agent.
-      "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
-      "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent.
-      "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
-      "visualization": "A String", # Whether to include visualizations in the response.
-    },
-    "dynamicConfig": { # Configuration for dynamic agents.
-      "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition.
-        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-          { # Represents a single field in a struct.
-            "name": "A String",
-            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-              "boolValue": True or False, # Represents a boolean value.
-              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                "values": [ # Repeated field of dynamically typed values.
-                  # Object with schema name: GenaiVertexV1beta1Value
-                ],
-              },
-              "nullValue": "A String", # Represents a null value.
-              "numberValue": 3.14, # Represents a double value.
-              "stringValue": "A String", # Represents a string value.
-              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-            },
-          },
-        ],
-      },
-    },
-  },
-  "content": { # The content of the response. # The content for the interaction.
-    "audio": { # An audio content block.
-      "channels": 42, # The number of audio channels.
-      "data": "A String", # The audio content.
-      "mimeType": "A String", # The mime type of the audio.
-      "sampleRate": 42, # The sample rate of the audio.
-      "uri": "A String", # The URI of the audio.
-    },
-    "document": { # A document content block.
-      "data": "A String", # The document content.
-      "mimeType": "A String", # The mime type of the document.
-      "uri": "A String", # The URI of the document.
-    },
-    "image": { # An image content block.
-      "data": "A String", # The image content.
-      "mimeType": "A String", # The mime type of the image.
-      "resolution": "A String", # The resolution of the media.
-      "uri": "A String", # The URI of the image.
-    },
-    "text": { # A text content block.
-      "annotations": [ # Citation information for model-generated content.
-        { # Citation information for model-generated content.
-          "endIndex": 42, # End of the attributed segment, exclusive.
-          "fileCitation": { # A file citation annotation. # A file citation annotation.
-            "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                { # Represents a single field in a struct.
-                  "name": "A String",
-                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                    "boolValue": True or False, # Represents a boolean value.
                     "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
                       "values": [ # Repeated field of dynamically typed values.
                         # Object with schema name: GenaiVertexV1beta1Value
@@ -7252,412 +5675,16702 @@ 

Method Details

}, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, +}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ getPoll(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) +
Fully typed proto, unary version of GetInteraction that returns Interaction proto.
+
+Args:
+  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
+  includeInput: boolean, Optional. If true, includes the input in the response.
+  lastEventId: string, Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
+  stream: boolean, Optional. If true, streams the interaction events as Server-Sent Events.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for InteractionService.CreateInteraction.
+  "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents.
+    "agent": "A String", # The name of the `Agent` used for generating the completion.
+    "deepResearchConfig": { # Configuration for the Deep Research agent.
+      "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
+      "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent.
+      "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
+      "visualization": "A String", # Whether to include visualizations in the response.
+    },
+    "dynamicConfig": { # Configuration for dynamic agents.
+      "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition.
+        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+          { # Represents a single field in a struct.
+            "name": "A String",
+            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiVertexV1beta1Value
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+            },
+          },
+        ],
+      },
+    },
+  },
+  "content": { # The content of the response. # The content for the interaction.
+    "audio": { # An audio content block.
+      "channels": 42, # The number of audio channels.
+      "data": "A String", # The audio content.
+      "mimeType": "A String", # The mime type of the audio.
+      "sampleRate": 42, # The sample rate of the audio.
+      "uri": "A String", # The URI of the audio.
+    },
+    "document": { # A document content block.
+      "data": "A String", # The document content.
+      "mimeType": "A String", # The mime type of the document.
+      "uri": "A String", # The URI of the document.
+    },
+    "image": { # An image content block.
+      "data": "A String", # The image content.
+      "mimeType": "A String", # The mime type of the image.
+      "resolution": "A String", # The resolution of the media.
+      "uri": "A String", # The URI of the image.
+    },
+    "text": { # A text content block.
+      "annotations": [ # Citation information for model-generated content.
+        { # Citation information for model-generated content.
+          "endIndex": 42, # End of the attributed segment, exclusive.
+          "fileCitation": { # A file citation annotation. # A file citation annotation.
+            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+            "documentUri": "A String", # The URI of the file.
+            "fileName": "A String", # The name of the file.
+            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+            "pageNumber": 42, # Page number of the cited document, if applicable.
+            "source": "A String", # Source attributed for a portion of the text.
+          },
+          "placeCitation": { # A place citation annotation. # A place citation annotation.
+            "name": "A String", # Title of the place.
+            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                "reviewId": "A String", # The ID of the review snippet.
+                "title": "A String", # Title of the review.
+                "url": "A String", # A link that corresponds to the user review on Google Maps.
+              },
+            ],
+            "url": "A String", # URI reference of the place.
+          },
+          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+            "title": "A String", # The title of the URL.
+            "url": "A String", # The URL.
+          },
+        },
+      ],
+      "text": "A String", # Required. The text content.
+    },
+    "thought": { # A thought content block.
+      "signature": "A String", # Signature to match the backend source to be part of the generation.
+      "summary": [ # A summary of the thought.
+        {
+          "image": { # An image content block.
+            "data": "A String", # The image content.
+            "mimeType": "A String", # The mime type of the image.
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String", # The URI of the image.
+          },
+          "text": { # A text content block.
+            "annotations": [ # Citation information for model-generated content.
+              { # Citation information for model-generated content.
+                "endIndex": 42, # End of the attributed segment, exclusive.
+                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                  "documentUri": "A String", # The URI of the file.
+                  "fileName": "A String", # The name of the file.
+                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                  "source": "A String", # Source attributed for a portion of the text.
+                },
+                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                  "title": "A String", # The title of the URL.
+                  "url": "A String", # The URL.
+                },
+              },
+            ],
+            "text": "A String", # Required. The text content.
+          },
+        },
+      ],
+    },
+    "toolCall": { # Tool call content.
+      "codeExecutionCall": { # Code execution content.
+        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+          "code": "A String", # The code to be executed.
+          "language": "A String", # Programming language of the `code`.
+        },
+      },
+      "fileSearchCall": { # File Search content.
+      },
+      "functionCall": { # A function tool call content block.
+        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+        "name": "A String", # Required. The name of the tool to call.
+      },
+      "googleMapsCall": { # Google Maps content.
+        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
           "queries": [ # The queries to be executed.
             "A String",
           ],
         },
       },
-      "googleSearchCall": { # Google Search content.
-        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
-          "queries": [ # Web search queries for the following-up web search.
-            "A String",
-          ],
+      "googleSearchCall": { # Google Search content.
+        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+          "queries": [ # Web search queries for the following-up web search.
+            "A String",
+          ],
+        },
+        "searchType": "A String", # The type of search grounding enabled.
+      },
+      "id": "A String", # Required. A unique ID for this specific tool call.
+      "mcpServerToolCall": { # MCPServer tool call content.
+        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+        "name": "A String", # Required. The name of the tool which was called.
+        "serverName": "A String", # Required. The name of the used MCP server.
+      },
+      "signature": "A String", # A signature hash for backend validation.
+      "urlContextCall": { # URL context content.
+        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+          "urls": [ # The URLs to fetch.
+            "A String",
+          ],
+        },
+      },
+    },
+    "toolResult": { # Tool result content.
+      "callId": "A String", # Required. ID to match the ID from the function call block.
+      "codeExecutionResult": { # Code execution result content.
+        "isError": True or False, # Whether the code execution resulted in an error.
+        "result": "A String", # Required. The output of the code execution.
+      },
+      "fileSearchResult": { # File Search result content.
+        "result": [ # Optional. The results of the File Search.
+          { # The result of the File Search.
+          },
+        ],
+      },
+      "functionResult": { # A function tool result content block.
+        "contentList": {
+          "contents": [
+            {
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+            },
+          ],
+        },
+        "isError": True or False, # Whether the tool call resulted in an error.
+        "name": "A String", # The name of the tool that was called.
+        "stringResult": "A String",
+        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+      },
+      "googleMapsResult": { # Google Maps result content.
+        "result": [ # Required. The results of the Google Maps.
+          { # The result of the Google Maps.
+            "places": [ # The places that were found.
+              {
+                "name": "A String", # Title of the place.
+                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                    "reviewId": "A String", # The ID of the review snippet.
+                    "title": "A String", # Title of the review.
+                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                  },
+                ],
+                "url": "A String", # URI reference of the place.
+              },
+            ],
+            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+          },
+        ],
+      },
+      "googleSearchResult": { # Google Search result content.
+        "isError": True or False, # Whether the Google Search resulted in an error.
+        "result": [ # Required. The results of the Google Search.
+          { # The result of the Google Search.
+            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+          },
+        ],
+      },
+      "mcpServerToolResult": { # MCPServer tool result content.
+        "contentList": {
+          "contents": [
+            {
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+            },
+          ],
+        },
+        "name": "A String", # Name of the tool which is called for this specific tool call.
+        "serverName": "A String", # The name of the used MCP server.
+        "stringResult": "A String",
+        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+      },
+      "signature": "A String", # A signature hash for backend validation.
+      "urlContextResult": { # URL context result content.
+        "isError": True or False, # Whether the URL context resulted in an error.
+        "result": [ # Required. The results of the URL context.
+          { # The result of the URL context.
+            "status": "A String", # The status of the URL retrieval.
+            "url": "A String", # The URL that was fetched.
+          },
+        ],
+      },
+    },
+    "video": { # A video content block.
+      "data": "A String", # The video content.
+      "mimeType": "A String", # The mime type of the video.
+      "resolution": "A String", # The resolution of the media.
+      "uri": "A String", # The URI of the video.
+    },
+  },
+  "contentList": { # A list of Content. # The inputs for the interaction.
+    "contents": [ # The contents of the list.
+      { # The content of the response.
+        "audio": { # An audio content block.
+          "channels": 42, # The number of audio channels.
+          "data": "A String", # The audio content.
+          "mimeType": "A String", # The mime type of the audio.
+          "sampleRate": 42, # The sample rate of the audio.
+          "uri": "A String", # The URI of the audio.
+        },
+        "document": { # A document content block.
+          "data": "A String", # The document content.
+          "mimeType": "A String", # The mime type of the document.
+          "uri": "A String", # The URI of the document.
+        },
+        "image": { # An image content block.
+          "data": "A String", # The image content.
+          "mimeType": "A String", # The mime type of the image.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the image.
+        },
+        "text": { # A text content block.
+          "annotations": [ # Citation information for model-generated content.
+            { # Citation information for model-generated content.
+              "endIndex": 42, # End of the attributed segment, exclusive.
+              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                "documentUri": "A String", # The URI of the file.
+                "fileName": "A String", # The name of the file.
+                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                "pageNumber": 42, # Page number of the cited document, if applicable.
+                "source": "A String", # Source attributed for a portion of the text.
+              },
+              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                "name": "A String", # Title of the place.
+                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                    "reviewId": "A String", # The ID of the review snippet.
+                    "title": "A String", # Title of the review.
+                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                  },
+                ],
+                "url": "A String", # URI reference of the place.
+              },
+              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                "title": "A String", # The title of the URL.
+                "url": "A String", # The URL.
+              },
+            },
+          ],
+          "text": "A String", # Required. The text content.
+        },
+        "thought": { # A thought content block.
+          "signature": "A String", # Signature to match the backend source to be part of the generation.
+          "summary": [ # A summary of the thought.
+            {
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+            },
+          ],
+        },
+        "toolCall": { # Tool call content.
+          "codeExecutionCall": { # Code execution content.
+            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+              "code": "A String", # The code to be executed.
+              "language": "A String", # Programming language of the `code`.
+            },
+          },
+          "fileSearchCall": { # File Search content.
+          },
+          "functionCall": { # A function tool call content block.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+            "name": "A String", # Required. The name of the tool to call.
+          },
+          "googleMapsCall": { # Google Maps content.
+            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+              "queries": [ # The queries to be executed.
+                "A String",
+              ],
+            },
+          },
+          "googleSearchCall": { # Google Search content.
+            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+              "queries": [ # Web search queries for the following-up web search.
+                "A String",
+              ],
+            },
+            "searchType": "A String", # The type of search grounding enabled.
+          },
+          "id": "A String", # Required. A unique ID for this specific tool call.
+          "mcpServerToolCall": { # MCPServer tool call content.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+            "name": "A String", # Required. The name of the tool which was called.
+            "serverName": "A String", # Required. The name of the used MCP server.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextCall": { # URL context content.
+            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+              "urls": [ # The URLs to fetch.
+                "A String",
+              ],
+            },
+          },
+        },
+        "toolResult": { # Tool result content.
+          "callId": "A String", # Required. ID to match the ID from the function call block.
+          "codeExecutionResult": { # Code execution result content.
+            "isError": True or False, # Whether the code execution resulted in an error.
+            "result": "A String", # Required. The output of the code execution.
+          },
+          "fileSearchResult": { # File Search result content.
+            "result": [ # Optional. The results of the File Search.
+              { # The result of the File Search.
+              },
+            ],
+          },
+          "functionResult": { # A function tool result content block.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "isError": True or False, # Whether the tool call resulted in an error.
+            "name": "A String", # The name of the tool that was called.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "googleMapsResult": { # Google Maps result content.
+            "result": [ # Required. The results of the Google Maps.
+              { # The result of the Google Maps.
+                "places": [ # The places that were found.
+                  {
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                ],
+                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+              },
+            ],
+          },
+          "googleSearchResult": { # Google Search result content.
+            "isError": True or False, # Whether the Google Search resulted in an error.
+            "result": [ # Required. The results of the Google Search.
+              { # The result of the Google Search.
+                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+              },
+            ],
+          },
+          "mcpServerToolResult": { # MCPServer tool result content.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Name of the tool which is called for this specific tool call.
+            "serverName": "A String", # The name of the used MCP server.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextResult": { # URL context result content.
+            "isError": True or False, # Whether the URL context resulted in an error.
+            "result": [ # Required. The results of the URL context.
+              { # The result of the URL context.
+                "status": "A String", # The status of the URL retrieval.
+                "url": "A String", # The URL that was fetched.
+              },
+            ],
+          },
+        },
+        "video": { # A video content block.
+          "data": "A String", # The video content.
+          "mimeType": "A String", # The mime type of the video.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the video.
+        },
+      },
+    ],
+  },
+  "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
+  "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment.
+  "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request.
+  "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
+  "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models.
+    "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
+    "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction.
+      "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+      "imageConfig": { # The configuration for image interaction. # Configuration for image interaction.
+        "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.
+        "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+      },
+      "maxOutputTokens": 42, # The maximum number of tokens to include in the response.
+      "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+      "seed": 42, # Seed used in decoding for reproducibility.
+      "speechConfig": [ # Configuration for speech interaction.
+        { # The configuration for speech interaction.
+          "language": "A String", # The language of the speech.
+          "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt.
+          "voice": "A String", # The voice of the speaker.
+        },
+      ],
+      "stopSequences": [ # A list of character sequences that will stop output interaction.
+        "A String",
+      ],
+      "temperature": 3.14, # Controls the randomness of the output.
+      "thinkingLevel": "A String", # The level of thought tokens that the model should generate.
+      "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
+      "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice.
+        "allowedTools": { # The configuration for allowed tools. # The allowed tools.
+          "mode": "A String", # The mode of the tool choice.
+          "tools": [ # The names of the allowed tools.
+            "A String",
+          ],
+        },
+      },
+      "toolChoiceMode": "A String", # The mode of the tool choice.
+      "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling.
+      "videoConfig": { # Configuration options for video generation. # Configuration for video generation.
+        "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media.
+      },
+    },
+    "model": "A String", # The name of the `Model` used for generating the completion.
+  },
+  "outputs": [ # Output only. Responses from the model.
+    { # The content of the response.
+      "audio": { # An audio content block.
+        "channels": 42, # The number of audio channels.
+        "data": "A String", # The audio content.
+        "mimeType": "A String", # The mime type of the audio.
+        "sampleRate": 42, # The sample rate of the audio.
+        "uri": "A String", # The URI of the audio.
+      },
+      "document": { # A document content block.
+        "data": "A String", # The document content.
+        "mimeType": "A String", # The mime type of the document.
+        "uri": "A String", # The URI of the document.
+      },
+      "image": { # An image content block.
+        "data": "A String", # The image content.
+        "mimeType": "A String", # The mime type of the image.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the image.
+      },
+      "text": { # A text content block.
+        "annotations": [ # Citation information for model-generated content.
+          { # Citation information for model-generated content.
+            "endIndex": 42, # End of the attributed segment, exclusive.
+            "fileCitation": { # A file citation annotation. # A file citation annotation.
+              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+              "documentUri": "A String", # The URI of the file.
+              "fileName": "A String", # The name of the file.
+              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+              "pageNumber": 42, # Page number of the cited document, if applicable.
+              "source": "A String", # Source attributed for a portion of the text.
+            },
+            "placeCitation": { # A place citation annotation. # A place citation annotation.
+              "name": "A String", # Title of the place.
+              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                  "reviewId": "A String", # The ID of the review snippet.
+                  "title": "A String", # Title of the review.
+                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                },
+              ],
+              "url": "A String", # URI reference of the place.
+            },
+            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+              "title": "A String", # The title of the URL.
+              "url": "A String", # The URL.
+            },
+          },
+        ],
+        "text": "A String", # Required. The text content.
+      },
+      "thought": { # A thought content block.
+        "signature": "A String", # Signature to match the backend source to be part of the generation.
+        "summary": [ # A summary of the thought.
+          {
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+          },
+        ],
+      },
+      "toolCall": { # Tool call content.
+        "codeExecutionCall": { # Code execution content.
+          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": { # File Search content.
+        },
+        "functionCall": { # A function tool call content block.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+          "name": "A String", # Required. The name of the tool to call.
+        },
+        "googleMapsCall": { # Google Maps content.
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": { # Google Search content.
+          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+          "searchType": "A String", # The type of search grounding enabled.
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": { # MCPServer tool call content.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+          "name": "A String", # Required. The name of the tool which was called.
+          "serverName": "A String", # Required. The name of the used MCP server.
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": { # URL context content.
+          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
+        },
+      },
+      "toolResult": { # Tool result content.
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": { # Code execution result content.
+          "isError": True or False, # Whether the code execution resulted in an error.
+          "result": "A String", # Required. The output of the code execution.
+        },
+        "fileSearchResult": { # File Search result content.
+          "result": [ # Optional. The results of the File Search.
+            { # The result of the File Search.
+            },
+          ],
+        },
+        "functionResult": { # A function tool result content block.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "isError": True or False, # Whether the tool call resulted in an error.
+          "name": "A String", # The name of the tool that was called.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "googleMapsResult": { # Google Maps result content.
+          "result": [ # Required. The results of the Google Maps.
+            { # The result of the Google Maps.
+              "places": [ # The places that were found.
+                {
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+              ],
+              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+            },
+          ],
+        },
+        "googleSearchResult": { # Google Search result content.
+          "isError": True or False, # Whether the Google Search resulted in an error.
+          "result": [ # Required. The results of the Google Search.
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": { # MCPServer tool result content.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Name of the tool which is called for this specific tool call.
+          "serverName": "A String", # The name of the used MCP server.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": { # URL context result content.
+          "isError": True or False, # Whether the URL context resulted in an error.
+          "result": [ # Required. The results of the URL context.
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
+            },
+          ],
+        },
+      },
+      "video": { # A video content block.
+        "data": "A String", # The video content.
+        "mimeType": "A String", # The mime type of the video.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the video.
+      },
+    },
+  ],
+  "previousInteractionId": "A String", # The ID of the previous interaction, if any.
+  "remoteEnvironment": { # Configuration for a custom environment.
+    "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains.
+      "allowlist": [ # List of allowed domains and their configurations.
+        { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request.
+          "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains.
+          "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token").
+            "a_key": "A String",
+          },
+        },
+      ],
+    },
+    "networkMode": "A String", # Network egress mode.
+    "sources": [
+      { # A source to be mounted into the environment.
+        "content": "A String", # The inline content if `type` is `INLINE`.
+        "encoding": "A String", # Optional encoding for inline content (e.g. `base64`).
+        "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.
+        "target": "A String", # Where the source should appear in the environment.
+        "type": "A String",
+      },
+    ],
+  },
+  "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
+    "boolValue": True or False, # Represents a boolean value.
+    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+      "audio": { # An audio content block.
+        "channels": 42, # The number of audio channels.
+        "data": "A String", # The audio content.
+        "mimeType": "A String", # The mime type of the audio.
+        "sampleRate": 42, # The sample rate of the audio.
+        "uri": "A String", # The URI of the audio.
+      },
+      "document": { # A document content block.
+        "data": "A String", # The document content.
+        "mimeType": "A String", # The mime type of the document.
+        "uri": "A String", # The URI of the document.
+      },
+      "image": { # An image content block.
+        "data": "A String", # The image content.
+        "mimeType": "A String", # The mime type of the image.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the image.
+      },
+      "text": { # A text content block.
+        "annotations": [ # Citation information for model-generated content.
+          { # Citation information for model-generated content.
+            "endIndex": 42, # End of the attributed segment, exclusive.
+            "fileCitation": { # A file citation annotation. # A file citation annotation.
+              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+              "documentUri": "A String", # The URI of the file.
+              "fileName": "A String", # The name of the file.
+              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+              "pageNumber": 42, # Page number of the cited document, if applicable.
+              "source": "A String", # Source attributed for a portion of the text.
+            },
+            "placeCitation": { # A place citation annotation. # A place citation annotation.
+              "name": "A String", # Title of the place.
+              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                  "reviewId": "A String", # The ID of the review snippet.
+                  "title": "A String", # Title of the review.
+                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                },
+              ],
+              "url": "A String", # URI reference of the place.
+            },
+            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+              "title": "A String", # The title of the URL.
+              "url": "A String", # The URL.
+            },
+          },
+        ],
+        "text": "A String", # Required. The text content.
+      },
+      "thought": { # A thought content block.
+        "signature": "A String", # Signature to match the backend source to be part of the generation.
+        "summary": [ # A summary of the thought.
+          {
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+          },
+        ],
+      },
+      "toolCall": { # Tool call content.
+        "codeExecutionCall": { # Code execution content.
+          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": { # File Search content.
+        },
+        "functionCall": { # A function tool call content block.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+          "name": "A String", # Required. The name of the tool to call.
+        },
+        "googleMapsCall": { # Google Maps content.
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": { # Google Search content.
+          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+          "searchType": "A String", # The type of search grounding enabled.
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": { # MCPServer tool call content.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+          "name": "A String", # Required. The name of the tool which was called.
+          "serverName": "A String", # Required. The name of the used MCP server.
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": { # URL context content.
+          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
+        },
+      },
+      "toolResult": { # Tool result content.
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": { # Code execution result content.
+          "isError": True or False, # Whether the code execution resulted in an error.
+          "result": "A String", # Required. The output of the code execution.
+        },
+        "fileSearchResult": { # File Search result content.
+          "result": [ # Optional. The results of the File Search.
+            { # The result of the File Search.
+            },
+          ],
+        },
+        "functionResult": { # A function tool result content block.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "isError": True or False, # Whether the tool call resulted in an error.
+          "name": "A String", # The name of the tool that was called.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "googleMapsResult": { # Google Maps result content.
+          "result": [ # Required. The results of the Google Maps.
+            { # The result of the Google Maps.
+              "places": [ # The places that were found.
+                {
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+              ],
+              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+            },
+          ],
+        },
+        "googleSearchResult": { # Google Search result content.
+          "isError": True or False, # Whether the Google Search resulted in an error.
+          "result": [ # Required. The results of the Google Search.
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": { # MCPServer tool result content.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Name of the tool which is called for this specific tool call.
+          "serverName": "A String", # The name of the used MCP server.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": { # URL context result content.
+          "isError": True or False, # Whether the URL context resulted in an error.
+          "result": [ # Required. The results of the URL context.
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
+            },
+          ],
+        },
+      },
+      "video": { # A video content block.
+        "data": "A String", # The video content.
+        "mimeType": "A String", # The mime type of the video.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the video.
+      },
+    },
+    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+      "values": [ # Repeated field of dynamically typed values.
+        # Object with schema name: GenaiVertexV1beta1Value
+      ],
+    },
+    "nullValue": "A String", # Represents a null value.
+    "numberValue": 3.14, # Represents a double value.
+    "stringValue": "A String", # Represents a string value.
+    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+  },
+  "responseFormatList": {
+    "responseFormats": [
+      {
+        "audio": { # Configuration for audio output format.
+          "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+          "delivery": "A String", # The delivery mode for the audio output.
+          "mimeType": "A String", # The MIME type of the audio output.
+          "sampleRate": 42, # Sample rate in Hz.
+        },
+        "image": { # Configuration for image output format.
+          "aspectRatio": "A String", # The aspect ratio for the image output.
+          "delivery": "A String", # The delivery mode for the image output.
+          "imageSize": "A String", # The size of the image output.
+          "mimeType": "A String", # The MIME type of the image output.
+        },
+        "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS
+          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+            { # Represents a single field in a struct.
+              "name": "A String",
+              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "thought": { # A thought content block.
+                    "signature": "A String", # Signature to match the backend source to be part of the generation.
+                    "summary": [ # A summary of the thought.
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "toolCall": { # Tool call content.
+                    "codeExecutionCall": { # Code execution content.
+                      "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                        "code": "A String", # The code to be executed.
+                        "language": "A String", # Programming language of the `code`.
+                      },
+                    },
+                    "fileSearchCall": { # File Search content.
+                    },
+                    "functionCall": { # A function tool call content block.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                      "name": "A String", # Required. The name of the tool to call.
+                    },
+                    "googleMapsCall": { # Google Maps content.
+                      "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                        "queries": [ # The queries to be executed.
+                          "A String",
+                        ],
+                      },
+                    },
+                    "googleSearchCall": { # Google Search content.
+                      "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                        "queries": [ # Web search queries for the following-up web search.
+                          "A String",
+                        ],
+                      },
+                      "searchType": "A String", # The type of search grounding enabled.
+                    },
+                    "id": "A String", # Required. A unique ID for this specific tool call.
+                    "mcpServerToolCall": { # MCPServer tool call content.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                      "name": "A String", # Required. The name of the tool which was called.
+                      "serverName": "A String", # Required. The name of the used MCP server.
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextCall": { # URL context content.
+                      "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                        "urls": [ # The URLs to fetch.
+                          "A String",
+                        ],
+                      },
+                    },
+                  },
+                  "toolResult": { # Tool result content.
+                    "callId": "A String", # Required. ID to match the ID from the function call block.
+                    "codeExecutionResult": { # Code execution result content.
+                      "isError": True or False, # Whether the code execution resulted in an error.
+                      "result": "A String", # Required. The output of the code execution.
+                    },
+                    "fileSearchResult": { # File Search result content.
+                      "result": [ # Optional. The results of the File Search.
+                        { # The result of the File Search.
+                        },
+                      ],
+                    },
+                    "functionResult": { # A function tool result content block.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "isError": True or False, # Whether the tool call resulted in an error.
+                      "name": "A String", # The name of the tool that was called.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "googleMapsResult": { # Google Maps result content.
+                      "result": [ # Required. The results of the Google Maps.
+                        { # The result of the Google Maps.
+                          "places": [ # The places that were found.
+                            {
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                          ],
+                          "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                        },
+                      ],
+                    },
+                    "googleSearchResult": { # Google Search result content.
+                      "isError": True or False, # Whether the Google Search resulted in an error.
+                      "result": [ # Required. The results of the Google Search.
+                        { # The result of the Google Search.
+                          "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                        },
+                      ],
+                    },
+                    "mcpServerToolResult": { # MCPServer tool result content.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "name": "A String", # Name of the tool which is called for this specific tool call.
+                      "serverName": "A String", # The name of the used MCP server.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextResult": { # URL context result content.
+                      "isError": True or False, # Whether the URL context resulted in an error.
+                      "result": [ # Required. The results of the URL context.
+                        { # The result of the URL context.
+                          "status": "A String", # The status of the URL retrieval.
+                          "url": "A String", # The URL that was fetched.
+                        },
+                      ],
+                    },
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeType": "A String", # The mime type of the video.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiVertexV1beta1Value
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
+                "numberValue": 3.14, # Represents a double value.
+                "stringValue": "A String", # Represents a string value.
+                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+              },
+            },
+          ],
+        },
+        "text": { # Configuration for text output format.
+          "mimeType": "A String", # The MIME type of the text output.
+          "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+        },
+        "video": { # Configuration for video output format.
+          "aspectRatio": "A String", # The aspect ratio for the video output.
+          "delivery": "A String", # The delivery mode for the video output.
+          "duration": "A String", # The duration for the video output.
+          "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI.
+        },
+      },
+    ],
+  },
+  "responseFormatSingleton": {
+    "audio": { # Configuration for audio output format.
+      "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+      "delivery": "A String", # The delivery mode for the audio output.
+      "mimeType": "A String", # The MIME type of the audio output.
+      "sampleRate": 42, # Sample rate in Hz.
+    },
+    "image": { # Configuration for image output format.
+      "aspectRatio": "A String", # The aspect ratio for the image output.
+      "delivery": "A String", # The delivery mode for the image output.
+      "imageSize": "A String", # The size of the image output.
+      "mimeType": "A String", # The MIME type of the image output.
+    },
+    "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS
+      "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+        { # Represents a single field in a struct.
+          "name": "A String",
+          "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+            "boolValue": True or False, # Represents a boolean value.
+            "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeType": "A String", # The mime type of the audio.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeType": "A String", # The mime type of the document.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "thought": { # A thought content block.
+                "signature": "A String", # Signature to match the backend source to be part of the generation.
+                "summary": [ # A summary of the thought.
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "toolCall": { # Tool call content.
+                "codeExecutionCall": { # Code execution content.
+                  "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                    "code": "A String", # The code to be executed.
+                    "language": "A String", # Programming language of the `code`.
+                  },
+                },
+                "fileSearchCall": { # File Search content.
+                },
+                "functionCall": { # A function tool call content block.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                  "name": "A String", # Required. The name of the tool to call.
+                },
+                "googleMapsCall": { # Google Maps content.
+                  "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                    "queries": [ # The queries to be executed.
+                      "A String",
+                    ],
+                  },
+                },
+                "googleSearchCall": { # Google Search content.
+                  "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                    "queries": [ # Web search queries for the following-up web search.
+                      "A String",
+                    ],
+                  },
+                  "searchType": "A String", # The type of search grounding enabled.
+                },
+                "id": "A String", # Required. A unique ID for this specific tool call.
+                "mcpServerToolCall": { # MCPServer tool call content.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                  "name": "A String", # Required. The name of the tool which was called.
+                  "serverName": "A String", # Required. The name of the used MCP server.
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextCall": { # URL context content.
+                  "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                    "urls": [ # The URLs to fetch.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "toolResult": { # Tool result content.
+                "callId": "A String", # Required. ID to match the ID from the function call block.
+                "codeExecutionResult": { # Code execution result content.
+                  "isError": True or False, # Whether the code execution resulted in an error.
+                  "result": "A String", # Required. The output of the code execution.
+                },
+                "fileSearchResult": { # File Search result content.
+                  "result": [ # Optional. The results of the File Search.
+                    { # The result of the File Search.
+                    },
+                  ],
+                },
+                "functionResult": { # A function tool result content block.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "isError": True or False, # Whether the tool call resulted in an error.
+                  "name": "A String", # The name of the tool that was called.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "googleMapsResult": { # Google Maps result content.
+                  "result": [ # Required. The results of the Google Maps.
+                    { # The result of the Google Maps.
+                      "places": [ # The places that were found.
+                        {
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                      ],
+                      "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                    },
+                  ],
+                },
+                "googleSearchResult": { # Google Search result content.
+                  "isError": True or False, # Whether the Google Search resulted in an error.
+                  "result": [ # Required. The results of the Google Search.
+                    { # The result of the Google Search.
+                      "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                    },
+                  ],
+                },
+                "mcpServerToolResult": { # MCPServer tool result content.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "name": "A String", # Name of the tool which is called for this specific tool call.
+                  "serverName": "A String", # The name of the used MCP server.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextResult": { # URL context result content.
+                  "isError": True or False, # Whether the URL context resulted in an error.
+                  "result": [ # Required. The results of the URL context.
+                    { # The result of the URL context.
+                      "status": "A String", # The status of the URL retrieval.
+                      "url": "A String", # The URL that was fetched.
+                    },
+                  ],
+                },
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeType": "A String", # The mime type of the video.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+            "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+              "values": [ # Repeated field of dynamically typed values.
+                # Object with schema name: GenaiVertexV1beta1Value
+              ],
+            },
+            "nullValue": "A String", # Represents a null value.
+            "numberValue": 3.14, # Represents a double value.
+            "stringValue": "A String", # Represents a string value.
+            "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+          },
+        },
+      ],
+    },
+    "text": { # Configuration for text output format.
+      "mimeType": "A String", # The MIME type of the text output.
+      "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json.
+        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+          { # Represents a single field in a struct.
+            "name": "A String",
+            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiVertexV1beta1Value
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+            },
+          },
+        ],
+      },
+    },
+    "video": { # Configuration for video output format.
+      "aspectRatio": "A String", # The aspect ratio for the video output.
+      "delivery": "A String", # The delivery mode for the video output.
+      "duration": "A String", # The duration for the video output.
+      "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI.
+    },
+  },
+  "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set.
+  "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO).
+    "A String",
+  ],
+  "role": "A String", # Output only. The role of the interaction.
+  "status": "A String", # Required. Output only. The status of the interaction.
+  "stepList": { # A list of Steps. # Input only. The steps for the interaction.
+    "steps": [ # The steps of the list.
+      { # A step in the interaction.
+        "modelOutput": { # Output generated by the model.
+          "content": [
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeType": "A String", # The mime type of the audio.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeType": "A String", # The mime type of the document.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "thought": { # A thought content block.
+                "signature": "A String", # Signature to match the backend source to be part of the generation.
+                "summary": [ # A summary of the thought.
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "toolCall": { # Tool call content.
+                "codeExecutionCall": { # Code execution content.
+                  "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                    "code": "A String", # The code to be executed.
+                    "language": "A String", # Programming language of the `code`.
+                  },
+                },
+                "fileSearchCall": { # File Search content.
+                },
+                "functionCall": { # A function tool call content block.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                  "name": "A String", # Required. The name of the tool to call.
+                },
+                "googleMapsCall": { # Google Maps content.
+                  "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                    "queries": [ # The queries to be executed.
+                      "A String",
+                    ],
+                  },
+                },
+                "googleSearchCall": { # Google Search content.
+                  "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                    "queries": [ # Web search queries for the following-up web search.
+                      "A String",
+                    ],
+                  },
+                  "searchType": "A String", # The type of search grounding enabled.
+                },
+                "id": "A String", # Required. A unique ID for this specific tool call.
+                "mcpServerToolCall": { # MCPServer tool call content.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                  "name": "A String", # Required. The name of the tool which was called.
+                  "serverName": "A String", # Required. The name of the used MCP server.
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextCall": { # URL context content.
+                  "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                    "urls": [ # The URLs to fetch.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "toolResult": { # Tool result content.
+                "callId": "A String", # Required. ID to match the ID from the function call block.
+                "codeExecutionResult": { # Code execution result content.
+                  "isError": True or False, # Whether the code execution resulted in an error.
+                  "result": "A String", # Required. The output of the code execution.
+                },
+                "fileSearchResult": { # File Search result content.
+                  "result": [ # Optional. The results of the File Search.
+                    { # The result of the File Search.
+                    },
+                  ],
+                },
+                "functionResult": { # A function tool result content block.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "isError": True or False, # Whether the tool call resulted in an error.
+                  "name": "A String", # The name of the tool that was called.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "googleMapsResult": { # Google Maps result content.
+                  "result": [ # Required. The results of the Google Maps.
+                    { # The result of the Google Maps.
+                      "places": [ # The places that were found.
+                        {
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                      ],
+                      "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                    },
+                  ],
+                },
+                "googleSearchResult": { # Google Search result content.
+                  "isError": True or False, # Whether the Google Search resulted in an error.
+                  "result": [ # Required. The results of the Google Search.
+                    { # The result of the Google Search.
+                      "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                    },
+                  ],
+                },
+                "mcpServerToolResult": { # MCPServer tool result content.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "name": "A String", # Name of the tool which is called for this specific tool call.
+                  "serverName": "A String", # The name of the used MCP server.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextResult": { # URL context result content.
+                  "isError": True or False, # Whether the URL context resulted in an error.
+                  "result": [ # Required. The results of the URL context.
+                    { # The result of the URL context.
+                      "status": "A String", # The status of the URL retrieval.
+                      "url": "A String", # The URL that was fetched.
+                    },
+                  ],
+                },
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeType": "A String", # The mime type of the video.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+          "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.
+          },
+        },
+        "thought": { # A thought step.
+          "signature": "A String", # A signature hash for backend validation.
+          "summary": [ # A summary of the thought.
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeType": "A String", # The mime type of the audio.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeType": "A String", # The mime type of the document.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "thought": { # A thought content block.
+                "signature": "A String", # Signature to match the backend source to be part of the generation.
+                "summary": [ # A summary of the thought.
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "toolCall": { # Tool call content.
+                "codeExecutionCall": { # Code execution content.
+                  "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                    "code": "A String", # The code to be executed.
+                    "language": "A String", # Programming language of the `code`.
+                  },
+                },
+                "fileSearchCall": { # File Search content.
+                },
+                "functionCall": { # A function tool call content block.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                  "name": "A String", # Required. The name of the tool to call.
+                },
+                "googleMapsCall": { # Google Maps content.
+                  "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                    "queries": [ # The queries to be executed.
+                      "A String",
+                    ],
+                  },
+                },
+                "googleSearchCall": { # Google Search content.
+                  "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                    "queries": [ # Web search queries for the following-up web search.
+                      "A String",
+                    ],
+                  },
+                  "searchType": "A String", # The type of search grounding enabled.
+                },
+                "id": "A String", # Required. A unique ID for this specific tool call.
+                "mcpServerToolCall": { # MCPServer tool call content.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                  "name": "A String", # Required. The name of the tool which was called.
+                  "serverName": "A String", # Required. The name of the used MCP server.
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextCall": { # URL context content.
+                  "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                    "urls": [ # The URLs to fetch.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "toolResult": { # Tool result content.
+                "callId": "A String", # Required. ID to match the ID from the function call block.
+                "codeExecutionResult": { # Code execution result content.
+                  "isError": True or False, # Whether the code execution resulted in an error.
+                  "result": "A String", # Required. The output of the code execution.
+                },
+                "fileSearchResult": { # File Search result content.
+                  "result": [ # Optional. The results of the File Search.
+                    { # The result of the File Search.
+                    },
+                  ],
+                },
+                "functionResult": { # A function tool result content block.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "isError": True or False, # Whether the tool call resulted in an error.
+                  "name": "A String", # The name of the tool that was called.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "googleMapsResult": { # Google Maps result content.
+                  "result": [ # Required. The results of the Google Maps.
+                    { # The result of the Google Maps.
+                      "places": [ # The places that were found.
+                        {
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                      ],
+                      "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                    },
+                  ],
+                },
+                "googleSearchResult": { # Google Search result content.
+                  "isError": True or False, # Whether the Google Search resulted in an error.
+                  "result": [ # Required. The results of the Google Search.
+                    { # The result of the Google Search.
+                      "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                    },
+                  ],
+                },
+                "mcpServerToolResult": { # MCPServer tool result content.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "name": "A String", # Name of the tool which is called for this specific tool call.
+                  "serverName": "A String", # The name of the used MCP server.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextResult": { # URL context result content.
+                  "isError": True or False, # Whether the URL context resulted in an error.
+                  "result": [ # Required. The results of the URL context.
+                    { # The result of the URL context.
+                      "status": "A String", # The status of the URL retrieval.
+                      "url": "A String", # The URL that was fetched.
+                    },
+                  ],
+                },
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeType": "A String", # The mime type of the video.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+        },
+        "toolCall": { # Tool call step.
+          "codeExecutionCall": { # Code execution call step.
+            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+              "code": "A String", # The code to be executed.
+              "language": "A String", # Programming language of the `code`.
+            },
+          },
+          "fileSearchCall": { # File Search call step.
+          },
+          "functionCall": { # A function tool call step.
+            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeType": "A String", # The mime type of the audio.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeType": "A String", # The mime type of the document.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "thought": { # A thought content block.
+                        "signature": "A String", # Signature to match the backend source to be part of the generation.
+                        "summary": [ # A summary of the thought.
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "toolCall": { # Tool call content.
+                        "codeExecutionCall": { # Code execution content.
+                          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                            "code": "A String", # The code to be executed.
+                            "language": "A String", # Programming language of the `code`.
+                          },
+                        },
+                        "fileSearchCall": { # File Search content.
+                        },
+                        "functionCall": { # A function tool call content block.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                          "name": "A String", # Required. The name of the tool to call.
+                        },
+                        "googleMapsCall": { # Google Maps content.
+                          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                            "queries": [ # The queries to be executed.
+                              "A String",
+                            ],
+                          },
+                        },
+                        "googleSearchCall": { # Google Search content.
+                          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                            "queries": [ # Web search queries for the following-up web search.
+                              "A String",
+                            ],
+                          },
+                          "searchType": "A String", # The type of search grounding enabled.
+                        },
+                        "id": "A String", # Required. A unique ID for this specific tool call.
+                        "mcpServerToolCall": { # MCPServer tool call content.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                          "name": "A String", # Required. The name of the tool which was called.
+                          "serverName": "A String", # Required. The name of the used MCP server.
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextCall": { # URL context content.
+                          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                            "urls": [ # The URLs to fetch.
+                              "A String",
+                            ],
+                          },
+                        },
+                      },
+                      "toolResult": { # Tool result content.
+                        "callId": "A String", # Required. ID to match the ID from the function call block.
+                        "codeExecutionResult": { # Code execution result content.
+                          "isError": True or False, # Whether the code execution resulted in an error.
+                          "result": "A String", # Required. The output of the code execution.
+                        },
+                        "fileSearchResult": { # File Search result content.
+                          "result": [ # Optional. The results of the File Search.
+                            { # The result of the File Search.
+                            },
+                          ],
+                        },
+                        "functionResult": { # A function tool result content block.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "isError": True or False, # Whether the tool call resulted in an error.
+                          "name": "A String", # The name of the tool that was called.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "googleMapsResult": { # Google Maps result content.
+                          "result": [ # Required. The results of the Google Maps.
+                            { # The result of the Google Maps.
+                              "places": [ # The places that were found.
+                                {
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                              ],
+                              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                            },
+                          ],
+                        },
+                        "googleSearchResult": { # Google Search result content.
+                          "isError": True or False, # Whether the Google Search resulted in an error.
+                          "result": [ # Required. The results of the Google Search.
+                            { # The result of the Google Search.
+                              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                            },
+                          ],
+                        },
+                        "mcpServerToolResult": { # MCPServer tool result content.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "name": "A String", # Name of the tool which is called for this specific tool call.
+                          "serverName": "A String", # The name of the used MCP server.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextResult": { # URL context result content.
+                          "isError": True or False, # Whether the URL context resulted in an error.
+                          "result": [ # Required. The results of the URL context.
+                            { # The result of the URL context.
+                              "status": "A String", # The status of the URL retrieval.
+                              "url": "A String", # The URL that was fetched.
+                            },
+                          ],
+                        },
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeType": "A String", # The mime type of the video.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiVertexV1beta1Value
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Required. The name of the tool to call.
+          },
+          "googleMapsCall": { # Google Maps call step.
+            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+              "queries": [ # The queries to be executed.
+                "A String",
+              ],
+            },
+          },
+          "googleSearchCall": { # Google Search call step.
+            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+              "queries": [ # Web search queries for the following-up web search.
+                "A String",
+              ],
+            },
+            "searchType": "A String", # The type of search grounding enabled.
+          },
+          "id": "A String", # Required. A unique ID for this specific tool call.
+          "mcpServerToolCall": { # MCPServer tool call step.
+            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeType": "A String", # The mime type of the audio.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeType": "A String", # The mime type of the document.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "thought": { # A thought content block.
+                        "signature": "A String", # Signature to match the backend source to be part of the generation.
+                        "summary": [ # A summary of the thought.
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "toolCall": { # Tool call content.
+                        "codeExecutionCall": { # Code execution content.
+                          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                            "code": "A String", # The code to be executed.
+                            "language": "A String", # Programming language of the `code`.
+                          },
+                        },
+                        "fileSearchCall": { # File Search content.
+                        },
+                        "functionCall": { # A function tool call content block.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                          "name": "A String", # Required. The name of the tool to call.
+                        },
+                        "googleMapsCall": { # Google Maps content.
+                          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                            "queries": [ # The queries to be executed.
+                              "A String",
+                            ],
+                          },
+                        },
+                        "googleSearchCall": { # Google Search content.
+                          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                            "queries": [ # Web search queries for the following-up web search.
+                              "A String",
+                            ],
+                          },
+                          "searchType": "A String", # The type of search grounding enabled.
+                        },
+                        "id": "A String", # Required. A unique ID for this specific tool call.
+                        "mcpServerToolCall": { # MCPServer tool call content.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                          "name": "A String", # Required. The name of the tool which was called.
+                          "serverName": "A String", # Required. The name of the used MCP server.
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextCall": { # URL context content.
+                          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                            "urls": [ # The URLs to fetch.
+                              "A String",
+                            ],
+                          },
+                        },
+                      },
+                      "toolResult": { # Tool result content.
+                        "callId": "A String", # Required. ID to match the ID from the function call block.
+                        "codeExecutionResult": { # Code execution result content.
+                          "isError": True or False, # Whether the code execution resulted in an error.
+                          "result": "A String", # Required. The output of the code execution.
+                        },
+                        "fileSearchResult": { # File Search result content.
+                          "result": [ # Optional. The results of the File Search.
+                            { # The result of the File Search.
+                            },
+                          ],
+                        },
+                        "functionResult": { # A function tool result content block.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "isError": True or False, # Whether the tool call resulted in an error.
+                          "name": "A String", # The name of the tool that was called.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "googleMapsResult": { # Google Maps result content.
+                          "result": [ # Required. The results of the Google Maps.
+                            { # The result of the Google Maps.
+                              "places": [ # The places that were found.
+                                {
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                              ],
+                              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                            },
+                          ],
+                        },
+                        "googleSearchResult": { # Google Search result content.
+                          "isError": True or False, # Whether the Google Search resulted in an error.
+                          "result": [ # Required. The results of the Google Search.
+                            { # The result of the Google Search.
+                              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                            },
+                          ],
+                        },
+                        "mcpServerToolResult": { # MCPServer tool result content.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "name": "A String", # Name of the tool which is called for this specific tool call.
+                          "serverName": "A String", # The name of the used MCP server.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextResult": { # URL context result content.
+                          "isError": True or False, # Whether the URL context resulted in an error.
+                          "result": [ # Required. The results of the URL context.
+                            { # The result of the URL context.
+                              "status": "A String", # The status of the URL retrieval.
+                              "url": "A String", # The URL that was fetched.
+                            },
+                          ],
+                        },
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeType": "A String", # The mime type of the video.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiVertexV1beta1Value
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Required. The name of the tool which was called.
+            "serverName": "A String", # Required. The name of the used MCP server.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextCall": { # URL context call step.
+            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+              "urls": [ # The URLs to fetch.
+                "A String",
+              ],
+            },
+          },
+        },
+        "toolResult": { # Tool result step.
+          "callId": "A String", # Required. ID to match the ID from the function call block.
+          "codeExecutionResult": { # Code execution result step.
+            "isError": True or False, # Whether the code execution resulted in an error.
+            "result": "A String", # Required. The output of the code execution.
+          },
+          "fileSearchResult": { # File Search result step.
+          },
+          "functionResult": { # Result of a function tool call.
+            "contentList": { # A list of Content.
+              "contents": [ # The contents of the list.
+                { # The content of the response.
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "thought": { # A thought content block.
+                    "signature": "A String", # Signature to match the backend source to be part of the generation.
+                    "summary": [ # A summary of the thought.
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "toolCall": { # Tool call content.
+                    "codeExecutionCall": { # Code execution content.
+                      "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                        "code": "A String", # The code to be executed.
+                        "language": "A String", # Programming language of the `code`.
+                      },
+                    },
+                    "fileSearchCall": { # File Search content.
+                    },
+                    "functionCall": { # A function tool call content block.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                      "name": "A String", # Required. The name of the tool to call.
+                    },
+                    "googleMapsCall": { # Google Maps content.
+                      "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                        "queries": [ # The queries to be executed.
+                          "A String",
+                        ],
+                      },
+                    },
+                    "googleSearchCall": { # Google Search content.
+                      "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                        "queries": [ # Web search queries for the following-up web search.
+                          "A String",
+                        ],
+                      },
+                      "searchType": "A String", # The type of search grounding enabled.
+                    },
+                    "id": "A String", # Required. A unique ID for this specific tool call.
+                    "mcpServerToolCall": { # MCPServer tool call content.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                      "name": "A String", # Required. The name of the tool which was called.
+                      "serverName": "A String", # Required. The name of the used MCP server.
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextCall": { # URL context content.
+                      "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                        "urls": [ # The URLs to fetch.
+                          "A String",
+                        ],
+                      },
+                    },
+                  },
+                  "toolResult": { # Tool result content.
+                    "callId": "A String", # Required. ID to match the ID from the function call block.
+                    "codeExecutionResult": { # Code execution result content.
+                      "isError": True or False, # Whether the code execution resulted in an error.
+                      "result": "A String", # Required. The output of the code execution.
+                    },
+                    "fileSearchResult": { # File Search result content.
+                      "result": [ # Optional. The results of the File Search.
+                        { # The result of the File Search.
+                        },
+                      ],
+                    },
+                    "functionResult": { # A function tool result content block.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "isError": True or False, # Whether the tool call resulted in an error.
+                      "name": "A String", # The name of the tool that was called.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "googleMapsResult": { # Google Maps result content.
+                      "result": [ # Required. The results of the Google Maps.
+                        { # The result of the Google Maps.
+                          "places": [ # The places that were found.
+                            {
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                          ],
+                          "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                        },
+                      ],
+                    },
+                    "googleSearchResult": { # Google Search result content.
+                      "isError": True or False, # Whether the Google Search resulted in an error.
+                      "result": [ # Required. The results of the Google Search.
+                        { # The result of the Google Search.
+                          "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                        },
+                      ],
+                    },
+                    "mcpServerToolResult": { # MCPServer tool result content.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "name": "A String", # Name of the tool which is called for this specific tool call.
+                      "serverName": "A String", # The name of the used MCP server.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextResult": { # URL context result content.
+                      "isError": True or False, # Whether the URL context resulted in an error.
+                      "result": [ # Required. The results of the URL context.
+                        { # The result of the URL context.
+                          "status": "A String", # The status of the URL retrieval.
+                          "url": "A String", # The URL that was fetched.
+                        },
+                      ],
+                    },
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeType": "A String", # The mime type of the video.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+              ],
+            },
+            "isError": True or False, # Whether the tool call resulted in an error.
+            "name": "A String", # The name of the tool that was called.
+            "stringResult": "A String",
+            "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeType": "A String", # The mime type of the audio.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeType": "A String", # The mime type of the document.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "thought": { # A thought content block.
+                        "signature": "A String", # Signature to match the backend source to be part of the generation.
+                        "summary": [ # A summary of the thought.
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "toolCall": { # Tool call content.
+                        "codeExecutionCall": { # Code execution content.
+                          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                            "code": "A String", # The code to be executed.
+                            "language": "A String", # Programming language of the `code`.
+                          },
+                        },
+                        "fileSearchCall": { # File Search content.
+                        },
+                        "functionCall": { # A function tool call content block.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                          "name": "A String", # Required. The name of the tool to call.
+                        },
+                        "googleMapsCall": { # Google Maps content.
+                          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                            "queries": [ # The queries to be executed.
+                              "A String",
+                            ],
+                          },
+                        },
+                        "googleSearchCall": { # Google Search content.
+                          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                            "queries": [ # Web search queries for the following-up web search.
+                              "A String",
+                            ],
+                          },
+                          "searchType": "A String", # The type of search grounding enabled.
+                        },
+                        "id": "A String", # Required. A unique ID for this specific tool call.
+                        "mcpServerToolCall": { # MCPServer tool call content.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                          "name": "A String", # Required. The name of the tool which was called.
+                          "serverName": "A String", # Required. The name of the used MCP server.
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextCall": { # URL context content.
+                          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                            "urls": [ # The URLs to fetch.
+                              "A String",
+                            ],
+                          },
+                        },
+                      },
+                      "toolResult": { # Tool result content.
+                        "callId": "A String", # Required. ID to match the ID from the function call block.
+                        "codeExecutionResult": { # Code execution result content.
+                          "isError": True or False, # Whether the code execution resulted in an error.
+                          "result": "A String", # Required. The output of the code execution.
+                        },
+                        "fileSearchResult": { # File Search result content.
+                          "result": [ # Optional. The results of the File Search.
+                            { # The result of the File Search.
+                            },
+                          ],
+                        },
+                        "functionResult": { # A function tool result content block.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "isError": True or False, # Whether the tool call resulted in an error.
+                          "name": "A String", # The name of the tool that was called.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "googleMapsResult": { # Google Maps result content.
+                          "result": [ # Required. The results of the Google Maps.
+                            { # The result of the Google Maps.
+                              "places": [ # The places that were found.
+                                {
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                              ],
+                              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                            },
+                          ],
+                        },
+                        "googleSearchResult": { # Google Search result content.
+                          "isError": True or False, # Whether the Google Search resulted in an error.
+                          "result": [ # Required. The results of the Google Search.
+                            { # The result of the Google Search.
+                              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                            },
+                          ],
+                        },
+                        "mcpServerToolResult": { # MCPServer tool result content.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "name": "A String", # Name of the tool which is called for this specific tool call.
+                          "serverName": "A String", # The name of the used MCP server.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextResult": { # URL context result content.
+                          "isError": True or False, # Whether the URL context resulted in an error.
+                          "result": [ # Required. The results of the URL context.
+                            { # The result of the URL context.
+                              "status": "A String", # The status of the URL retrieval.
+                              "url": "A String", # The URL that was fetched.
+                            },
+                          ],
+                        },
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeType": "A String", # The mime type of the video.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiVertexV1beta1Value
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+          },
+          "googleMapsResult": { # Google Maps result step.
+            "result": [
+              { # The result of the Google Maps.
+                "places": [
+                  {
+                    "name": "A String",
+                    "placeId": "A String",
+                    "reviewSnippets": [
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String",
+                  },
+                ],
+                "widgetContextToken": "A String",
+              },
+            ],
+          },
+          "googleSearchResult": { # Google Search result step.
+            "isError": True or False, # Whether the Google Search resulted in an error.
+            "result": [ # Required. The results of the Google Search.
+              { # The result of the Google Search.
+                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+              },
+            ],
+          },
+          "mcpServerToolResult": { # MCPServer tool result step.
+            "contentList": { # A list of Content.
+              "contents": [ # The contents of the list.
+                { # The content of the response.
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "thought": { # A thought content block.
+                    "signature": "A String", # Signature to match the backend source to be part of the generation.
+                    "summary": [ # A summary of the thought.
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "toolCall": { # Tool call content.
+                    "codeExecutionCall": { # Code execution content.
+                      "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                        "code": "A String", # The code to be executed.
+                        "language": "A String", # Programming language of the `code`.
+                      },
+                    },
+                    "fileSearchCall": { # File Search content.
+                    },
+                    "functionCall": { # A function tool call content block.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                      "name": "A String", # Required. The name of the tool to call.
+                    },
+                    "googleMapsCall": { # Google Maps content.
+                      "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                        "queries": [ # The queries to be executed.
+                          "A String",
+                        ],
+                      },
+                    },
+                    "googleSearchCall": { # Google Search content.
+                      "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                        "queries": [ # Web search queries for the following-up web search.
+                          "A String",
+                        ],
+                      },
+                      "searchType": "A String", # The type of search grounding enabled.
+                    },
+                    "id": "A String", # Required. A unique ID for this specific tool call.
+                    "mcpServerToolCall": { # MCPServer tool call content.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                      "name": "A String", # Required. The name of the tool which was called.
+                      "serverName": "A String", # Required. The name of the used MCP server.
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextCall": { # URL context content.
+                      "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                        "urls": [ # The URLs to fetch.
+                          "A String",
+                        ],
+                      },
+                    },
+                  },
+                  "toolResult": { # Tool result content.
+                    "callId": "A String", # Required. ID to match the ID from the function call block.
+                    "codeExecutionResult": { # Code execution result content.
+                      "isError": True or False, # Whether the code execution resulted in an error.
+                      "result": "A String", # Required. The output of the code execution.
+                    },
+                    "fileSearchResult": { # File Search result content.
+                      "result": [ # Optional. The results of the File Search.
+                        { # The result of the File Search.
+                        },
+                      ],
+                    },
+                    "functionResult": { # A function tool result content block.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "isError": True or False, # Whether the tool call resulted in an error.
+                      "name": "A String", # The name of the tool that was called.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "googleMapsResult": { # Google Maps result content.
+                      "result": [ # Required. The results of the Google Maps.
+                        { # The result of the Google Maps.
+                          "places": [ # The places that were found.
+                            {
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                          ],
+                          "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                        },
+                      ],
+                    },
+                    "googleSearchResult": { # Google Search result content.
+                      "isError": True or False, # Whether the Google Search resulted in an error.
+                      "result": [ # Required. The results of the Google Search.
+                        { # The result of the Google Search.
+                          "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                        },
+                      ],
+                    },
+                    "mcpServerToolResult": { # MCPServer tool result content.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "name": "A String", # Name of the tool which is called for this specific tool call.
+                      "serverName": "A String", # The name of the used MCP server.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextResult": { # URL context result content.
+                      "isError": True or False, # Whether the URL context resulted in an error.
+                      "result": [ # Required. The results of the URL context.
+                        { # The result of the URL context.
+                          "status": "A String", # The status of the URL retrieval.
+                          "url": "A String", # The URL that was fetched.
+                        },
+                      ],
+                    },
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeType": "A String", # The mime type of the video.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Name of the tool which is called for this specific tool call.
+            "serverName": "A String", # The name of the used MCP server.
+            "stringResult": "A String",
+            "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeType": "A String", # The mime type of the audio.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeType": "A String", # The mime type of the document.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "thought": { # A thought content block.
+                        "signature": "A String", # Signature to match the backend source to be part of the generation.
+                        "summary": [ # A summary of the thought.
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "toolCall": { # Tool call content.
+                        "codeExecutionCall": { # Code execution content.
+                          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                            "code": "A String", # The code to be executed.
+                            "language": "A String", # Programming language of the `code`.
+                          },
+                        },
+                        "fileSearchCall": { # File Search content.
+                        },
+                        "functionCall": { # A function tool call content block.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                          "name": "A String", # Required. The name of the tool to call.
+                        },
+                        "googleMapsCall": { # Google Maps content.
+                          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                            "queries": [ # The queries to be executed.
+                              "A String",
+                            ],
+                          },
+                        },
+                        "googleSearchCall": { # Google Search content.
+                          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                            "queries": [ # Web search queries for the following-up web search.
+                              "A String",
+                            ],
+                          },
+                          "searchType": "A String", # The type of search grounding enabled.
+                        },
+                        "id": "A String", # Required. A unique ID for this specific tool call.
+                        "mcpServerToolCall": { # MCPServer tool call content.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                          "name": "A String", # Required. The name of the tool which was called.
+                          "serverName": "A String", # Required. The name of the used MCP server.
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextCall": { # URL context content.
+                          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                            "urls": [ # The URLs to fetch.
+                              "A String",
+                            ],
+                          },
+                        },
+                      },
+                      "toolResult": { # Tool result content.
+                        "callId": "A String", # Required. ID to match the ID from the function call block.
+                        "codeExecutionResult": { # Code execution result content.
+                          "isError": True or False, # Whether the code execution resulted in an error.
+                          "result": "A String", # Required. The output of the code execution.
+                        },
+                        "fileSearchResult": { # File Search result content.
+                          "result": [ # Optional. The results of the File Search.
+                            { # The result of the File Search.
+                            },
+                          ],
+                        },
+                        "functionResult": { # A function tool result content block.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "isError": True or False, # Whether the tool call resulted in an error.
+                          "name": "A String", # The name of the tool that was called.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "googleMapsResult": { # Google Maps result content.
+                          "result": [ # Required. The results of the Google Maps.
+                            { # The result of the Google Maps.
+                              "places": [ # The places that were found.
+                                {
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                              ],
+                              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                            },
+                          ],
+                        },
+                        "googleSearchResult": { # Google Search result content.
+                          "isError": True or False, # Whether the Google Search resulted in an error.
+                          "result": [ # Required. The results of the Google Search.
+                            { # The result of the Google Search.
+                              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                            },
+                          ],
+                        },
+                        "mcpServerToolResult": { # MCPServer tool result content.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "name": "A String", # Name of the tool which is called for this specific tool call.
+                          "serverName": "A String", # The name of the used MCP server.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextResult": { # URL context result content.
+                          "isError": True or False, # Whether the URL context resulted in an error.
+                          "result": [ # Required. The results of the URL context.
+                            { # The result of the URL context.
+                              "status": "A String", # The status of the URL retrieval.
+                              "url": "A String", # The URL that was fetched.
+                            },
+                          ],
+                        },
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeType": "A String", # The mime type of the video.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiVertexV1beta1Value
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextResult": { # URL context result step.
+            "isError": True or False, # Whether the URL context resulted in an error.
+            "result": [ # Required. The results of the URL context.
+              { # The result of the URL context.
+                "status": "A String", # The status of the URL retrieval.
+                "url": "A String", # The URL that was fetched.
+              },
+            ],
+          },
+        },
+        "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only
+          "contentList": { # A list of Content. # The content of the step. An array of Content objects.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "contentString": "A String", # The content of the step. A single string.
+        },
+      },
+    ],
+  },
+  "steps": [ # Required. Output only. The steps that make up the interaction.
+    { # A step in the interaction.
+      "modelOutput": { # Output generated by the model.
+        "content": [
+          { # The content of the response.
+            "audio": { # An audio content block.
+              "channels": 42, # The number of audio channels.
+              "data": "A String", # The audio content.
+              "mimeType": "A String", # The mime type of the audio.
+              "sampleRate": 42, # The sample rate of the audio.
+              "uri": "A String", # The URI of the audio.
+            },
+            "document": { # A document content block.
+              "data": "A String", # The document content.
+              "mimeType": "A String", # The mime type of the document.
+              "uri": "A String", # The URI of the document.
+            },
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+            "thought": { # A thought content block.
+              "signature": "A String", # Signature to match the backend source to be part of the generation.
+              "summary": [ # A summary of the thought.
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "toolCall": { # Tool call content.
+              "codeExecutionCall": { # Code execution content.
+                "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                  "code": "A String", # The code to be executed.
+                  "language": "A String", # Programming language of the `code`.
+                },
+              },
+              "fileSearchCall": { # File Search content.
+              },
+              "functionCall": { # A function tool call content block.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                "name": "A String", # Required. The name of the tool to call.
+              },
+              "googleMapsCall": { # Google Maps content.
+                "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                  "queries": [ # The queries to be executed.
+                    "A String",
+                  ],
+                },
+              },
+              "googleSearchCall": { # Google Search content.
+                "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                  "queries": [ # Web search queries for the following-up web search.
+                    "A String",
+                  ],
+                },
+                "searchType": "A String", # The type of search grounding enabled.
+              },
+              "id": "A String", # Required. A unique ID for this specific tool call.
+              "mcpServerToolCall": { # MCPServer tool call content.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                "name": "A String", # Required. The name of the tool which was called.
+                "serverName": "A String", # Required. The name of the used MCP server.
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextCall": { # URL context content.
+                "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                  "urls": [ # The URLs to fetch.
+                    "A String",
+                  ],
+                },
+              },
+            },
+            "toolResult": { # Tool result content.
+              "callId": "A String", # Required. ID to match the ID from the function call block.
+              "codeExecutionResult": { # Code execution result content.
+                "isError": True or False, # Whether the code execution resulted in an error.
+                "result": "A String", # Required. The output of the code execution.
+              },
+              "fileSearchResult": { # File Search result content.
+                "result": [ # Optional. The results of the File Search.
+                  { # The result of the File Search.
+                  },
+                ],
+              },
+              "functionResult": { # A function tool result content block.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "isError": True or False, # Whether the tool call resulted in an error.
+                "name": "A String", # The name of the tool that was called.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "googleMapsResult": { # Google Maps result content.
+                "result": [ # Required. The results of the Google Maps.
+                  { # The result of the Google Maps.
+                    "places": [ # The places that were found.
+                      {
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                    ],
+                    "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                  },
+                ],
+              },
+              "googleSearchResult": { # Google Search result content.
+                "isError": True or False, # Whether the Google Search resulted in an error.
+                "result": [ # Required. The results of the Google Search.
+                  { # The result of the Google Search.
+                    "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                  },
+                ],
+              },
+              "mcpServerToolResult": { # MCPServer tool result content.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "name": "A String", # Name of the tool which is called for this specific tool call.
+                "serverName": "A String", # The name of the used MCP server.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextResult": { # URL context result content.
+                "isError": True or False, # Whether the URL context resulted in an error.
+                "result": [ # Required. The results of the URL context.
+                  { # The result of the URL context.
+                    "status": "A String", # The status of the URL retrieval.
+                    "url": "A String", # The URL that was fetched.
+                  },
+                ],
+              },
+            },
+            "video": { # A video content block.
+              "data": "A String", # The video content.
+              "mimeType": "A String", # The mime type of the video.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the video.
+            },
+          },
+        ],
+        "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.
+        },
+      },
+      "thought": { # A thought step.
+        "signature": "A String", # A signature hash for backend validation.
+        "summary": [ # A summary of the thought.
+          { # The content of the response.
+            "audio": { # An audio content block.
+              "channels": 42, # The number of audio channels.
+              "data": "A String", # The audio content.
+              "mimeType": "A String", # The mime type of the audio.
+              "sampleRate": 42, # The sample rate of the audio.
+              "uri": "A String", # The URI of the audio.
+            },
+            "document": { # A document content block.
+              "data": "A String", # The document content.
+              "mimeType": "A String", # The mime type of the document.
+              "uri": "A String", # The URI of the document.
+            },
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+            "thought": { # A thought content block.
+              "signature": "A String", # Signature to match the backend source to be part of the generation.
+              "summary": [ # A summary of the thought.
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "toolCall": { # Tool call content.
+              "codeExecutionCall": { # Code execution content.
+                "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                  "code": "A String", # The code to be executed.
+                  "language": "A String", # Programming language of the `code`.
+                },
+              },
+              "fileSearchCall": { # File Search content.
+              },
+              "functionCall": { # A function tool call content block.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                "name": "A String", # Required. The name of the tool to call.
+              },
+              "googleMapsCall": { # Google Maps content.
+                "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                  "queries": [ # The queries to be executed.
+                    "A String",
+                  ],
+                },
+              },
+              "googleSearchCall": { # Google Search content.
+                "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                  "queries": [ # Web search queries for the following-up web search.
+                    "A String",
+                  ],
+                },
+                "searchType": "A String", # The type of search grounding enabled.
+              },
+              "id": "A String", # Required. A unique ID for this specific tool call.
+              "mcpServerToolCall": { # MCPServer tool call content.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                "name": "A String", # Required. The name of the tool which was called.
+                "serverName": "A String", # Required. The name of the used MCP server.
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextCall": { # URL context content.
+                "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                  "urls": [ # The URLs to fetch.
+                    "A String",
+                  ],
+                },
+              },
+            },
+            "toolResult": { # Tool result content.
+              "callId": "A String", # Required. ID to match the ID from the function call block.
+              "codeExecutionResult": { # Code execution result content.
+                "isError": True or False, # Whether the code execution resulted in an error.
+                "result": "A String", # Required. The output of the code execution.
+              },
+              "fileSearchResult": { # File Search result content.
+                "result": [ # Optional. The results of the File Search.
+                  { # The result of the File Search.
+                  },
+                ],
+              },
+              "functionResult": { # A function tool result content block.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "isError": True or False, # Whether the tool call resulted in an error.
+                "name": "A String", # The name of the tool that was called.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "googleMapsResult": { # Google Maps result content.
+                "result": [ # Required. The results of the Google Maps.
+                  { # The result of the Google Maps.
+                    "places": [ # The places that were found.
+                      {
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                    ],
+                    "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                  },
+                ],
+              },
+              "googleSearchResult": { # Google Search result content.
+                "isError": True or False, # Whether the Google Search resulted in an error.
+                "result": [ # Required. The results of the Google Search.
+                  { # The result of the Google Search.
+                    "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                  },
+                ],
+              },
+              "mcpServerToolResult": { # MCPServer tool result content.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "name": "A String", # Name of the tool which is called for this specific tool call.
+                "serverName": "A String", # The name of the used MCP server.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextResult": { # URL context result content.
+                "isError": True or False, # Whether the URL context resulted in an error.
+                "result": [ # Required. The results of the URL context.
+                  { # The result of the URL context.
+                    "status": "A String", # The status of the URL retrieval.
+                    "url": "A String", # The URL that was fetched.
+                  },
+                ],
+              },
+            },
+            "video": { # A video content block.
+              "data": "A String", # The video content.
+              "mimeType": "A String", # The mime type of the video.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the video.
+            },
+          },
+        ],
+      },
+      "toolCall": { # Tool call step.
+        "codeExecutionCall": { # Code execution call step.
+          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": { # File Search call step.
+        },
+        "functionCall": { # A function tool call step.
+          "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Required. The name of the tool to call.
+        },
+        "googleMapsCall": { # Google Maps call step.
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": { # Google Search call step.
+          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+          "searchType": "A String", # The type of search grounding enabled.
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": { # MCPServer tool call step.
+          "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Required. The name of the tool which was called.
+          "serverName": "A String", # Required. The name of the used MCP server.
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": { # URL context call step.
+          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
+        },
+      },
+      "toolResult": { # Tool result step.
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": { # Code execution result step.
+          "isError": True or False, # Whether the code execution resulted in an error.
+          "result": "A String", # Required. The output of the code execution.
+        },
+        "fileSearchResult": { # File Search result step.
+        },
+        "functionResult": { # Result of a function tool call.
+          "contentList": { # A list of Content.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "isError": True or False, # Whether the tool call resulted in an error.
+          "name": "A String", # The name of the tool that was called.
+          "stringResult": "A String",
+          "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+        },
+        "googleMapsResult": { # Google Maps result step.
+          "result": [
+            { # The result of the Google Maps.
+              "places": [
+                {
+                  "name": "A String",
+                  "placeId": "A String",
+                  "reviewSnippets": [
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String",
+                },
+              ],
+              "widgetContextToken": "A String",
+            },
+          ],
+        },
+        "googleSearchResult": { # Google Search result step.
+          "isError": True or False, # Whether the Google Search resulted in an error.
+          "result": [ # Required. The results of the Google Search.
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": { # MCPServer tool result step.
+          "contentList": { # A list of Content.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Name of the tool which is called for this specific tool call.
+          "serverName": "A String", # The name of the used MCP server.
+          "stringResult": "A String",
+          "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": { # URL context result step.
+          "isError": True or False, # Whether the URL context resulted in an error.
+          "result": [ # Required. The results of the URL context.
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
+            },
+          ],
+        },
+      },
+      "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only
+        "contentList": { # A list of Content. # The content of the step. An array of Content objects.
+          "contents": [ # The contents of the list.
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeType": "A String", # The mime type of the audio.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeType": "A String", # The mime type of the document.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "thought": { # A thought content block.
+                "signature": "A String", # Signature to match the backend source to be part of the generation.
+                "summary": [ # A summary of the thought.
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "toolCall": { # Tool call content.
+                "codeExecutionCall": { # Code execution content.
+                  "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                    "code": "A String", # The code to be executed.
+                    "language": "A String", # Programming language of the `code`.
+                  },
+                },
+                "fileSearchCall": { # File Search content.
+                },
+                "functionCall": { # A function tool call content block.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                  "name": "A String", # Required. The name of the tool to call.
+                },
+                "googleMapsCall": { # Google Maps content.
+                  "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                    "queries": [ # The queries to be executed.
+                      "A String",
+                    ],
+                  },
+                },
+                "googleSearchCall": { # Google Search content.
+                  "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                    "queries": [ # Web search queries for the following-up web search.
+                      "A String",
+                    ],
+                  },
+                  "searchType": "A String", # The type of search grounding enabled.
+                },
+                "id": "A String", # Required. A unique ID for this specific tool call.
+                "mcpServerToolCall": { # MCPServer tool call content.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                  "name": "A String", # Required. The name of the tool which was called.
+                  "serverName": "A String", # Required. The name of the used MCP server.
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextCall": { # URL context content.
+                  "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                    "urls": [ # The URLs to fetch.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "toolResult": { # Tool result content.
+                "callId": "A String", # Required. ID to match the ID from the function call block.
+                "codeExecutionResult": { # Code execution result content.
+                  "isError": True or False, # Whether the code execution resulted in an error.
+                  "result": "A String", # Required. The output of the code execution.
+                },
+                "fileSearchResult": { # File Search result content.
+                  "result": [ # Optional. The results of the File Search.
+                    { # The result of the File Search.
+                    },
+                  ],
+                },
+                "functionResult": { # A function tool result content block.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "isError": True or False, # Whether the tool call resulted in an error.
+                  "name": "A String", # The name of the tool that was called.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "googleMapsResult": { # Google Maps result content.
+                  "result": [ # Required. The results of the Google Maps.
+                    { # The result of the Google Maps.
+                      "places": [ # The places that were found.
+                        {
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                      ],
+                      "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                    },
+                  ],
+                },
+                "googleSearchResult": { # Google Search result content.
+                  "isError": True or False, # Whether the Google Search resulted in an error.
+                  "result": [ # Required. The results of the Google Search.
+                    { # The result of the Google Search.
+                      "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                    },
+                  ],
+                },
+                "mcpServerToolResult": { # MCPServer tool result content.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "name": "A String", # Name of the tool which is called for this specific tool call.
+                  "serverName": "A String", # The name of the used MCP server.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextResult": { # URL context result content.
+                  "isError": True or False, # Whether the URL context resulted in an error.
+                  "result": [ # Required. The results of the URL context.
+                    { # The result of the URL context.
+                      "status": "A String", # The status of the URL retrieval.
+                      "url": "A String", # The URL that was fetched.
+                    },
+                  ],
+                },
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeType": "A String", # The mime type of the video.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+        },
+        "contentString": "A String", # The content of the step. A single string.
+      },
+    },
+  ],
+  "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input.
+  "systemInstruction": "A String", # System instruction for the interaction.
+  "tools": [ # A list of tool declarations the model may call during interaction.
+    { # A tool that can be used by the model.
+      "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code.
+      },
+      "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer.
+        "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use.
+          "A String",
+        ],
+        "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request.
+        "environment": "A String", # The environment being operated.
+        "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call.
+          "A String",
+        ],
+      },
+      "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files.
+        "fileSearchStoreNames": [ # The file search store names to search.
+          "A String",
+        ],
+        "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks.
+        "topK": 42, # The number of semantic retrieval chunks to retrieve.
+      },
+      "function": { # A tool that can be used by the model. # A function that can be used by the model.
+        "description": "A String", # A description of the function.
+        "name": "A String", # The name of the function.
+        "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters.
+          "boolValue": True or False, # Represents a boolean value.
+          "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+            "audio": { # An audio content block.
+              "channels": 42, # The number of audio channels.
+              "data": "A String", # The audio content.
+              "mimeType": "A String", # The mime type of the audio.
+              "sampleRate": 42, # The sample rate of the audio.
+              "uri": "A String", # The URI of the audio.
+            },
+            "document": { # A document content block.
+              "data": "A String", # The document content.
+              "mimeType": "A String", # The mime type of the document.
+              "uri": "A String", # The URI of the document.
+            },
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+            "thought": { # A thought content block.
+              "signature": "A String", # Signature to match the backend source to be part of the generation.
+              "summary": [ # A summary of the thought.
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "toolCall": { # Tool call content.
+              "codeExecutionCall": { # Code execution content.
+                "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                  "code": "A String", # The code to be executed.
+                  "language": "A String", # Programming language of the `code`.
+                },
+              },
+              "fileSearchCall": { # File Search content.
+              },
+              "functionCall": { # A function tool call content block.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                "name": "A String", # Required. The name of the tool to call.
+              },
+              "googleMapsCall": { # Google Maps content.
+                "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                  "queries": [ # The queries to be executed.
+                    "A String",
+                  ],
+                },
+              },
+              "googleSearchCall": { # Google Search content.
+                "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                  "queries": [ # Web search queries for the following-up web search.
+                    "A String",
+                  ],
+                },
+                "searchType": "A String", # The type of search grounding enabled.
+              },
+              "id": "A String", # Required. A unique ID for this specific tool call.
+              "mcpServerToolCall": { # MCPServer tool call content.
+                "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                "name": "A String", # Required. The name of the tool which was called.
+                "serverName": "A String", # Required. The name of the used MCP server.
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextCall": { # URL context content.
+                "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                  "urls": [ # The URLs to fetch.
+                    "A String",
+                  ],
+                },
+              },
+            },
+            "toolResult": { # Tool result content.
+              "callId": "A String", # Required. ID to match the ID from the function call block.
+              "codeExecutionResult": { # Code execution result content.
+                "isError": True or False, # Whether the code execution resulted in an error.
+                "result": "A String", # Required. The output of the code execution.
+              },
+              "fileSearchResult": { # File Search result content.
+                "result": [ # Optional. The results of the File Search.
+                  { # The result of the File Search.
+                  },
+                ],
+              },
+              "functionResult": { # A function tool result content block.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "isError": True or False, # Whether the tool call resulted in an error.
+                "name": "A String", # The name of the tool that was called.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "googleMapsResult": { # Google Maps result content.
+                "result": [ # Required. The results of the Google Maps.
+                  { # The result of the Google Maps.
+                    "places": [ # The places that were found.
+                      {
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                    ],
+                    "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                  },
+                ],
+              },
+              "googleSearchResult": { # Google Search result content.
+                "isError": True or False, # Whether the Google Search resulted in an error.
+                "result": [ # Required. The results of the Google Search.
+                  { # The result of the Google Search.
+                    "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                  },
+                ],
+              },
+              "mcpServerToolResult": { # MCPServer tool result content.
+                "contentList": {
+                  "contents": [
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "name": "A String", # Name of the tool which is called for this specific tool call.
+                "serverName": "A String", # The name of the used MCP server.
+                "stringResult": "A String",
+                "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+              },
+              "signature": "A String", # A signature hash for backend validation.
+              "urlContextResult": { # URL context result content.
+                "isError": True or False, # Whether the URL context resulted in an error.
+                "result": [ # Required. The results of the URL context.
+                  { # The result of the URL context.
+                    "status": "A String", # The status of the URL retrieval.
+                    "url": "A String", # The URL that was fetched.
+                  },
+                ],
+              },
+            },
+            "video": { # A video content block.
+              "data": "A String", # The video content.
+              "mimeType": "A String", # The mime type of the video.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the video.
+            },
+          },
+          "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+            "values": [ # Repeated field of dynamically typed values.
+              # Object with schema name: GenaiVertexV1beta1Value
+            ],
+          },
+          "nullValue": "A String", # Represents a null value.
+          "numberValue": 3.14, # Represents a double value.
+          "stringValue": "A String", # Represents a string value.
+          "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+        },
+      },
+      "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps.
+        "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response.
+        "latitude": 3.14, # The latitude of the user's location.
+        "longitude": 3.14, # The longitude of the user's location.
+      },
+      "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google.
+        "searchTypes": [ # The types of search grounding to enable.
+          "A String",
+        ],
+      },
+      "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions.
+        "allowedTools": [ # The allowed tools.
+          { # The configuration for allowed tools.
+            "mode": "A String", # The mode of the tool choice.
+            "tools": [ # The names of the allowed tools.
+              "A String",
+            ],
+          },
+        ],
+        "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed.
+          "a_key": "A String",
+        },
+        "name": "A String", # The name of the MCPServer.
+        "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp"
+      },
+      "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files.
+        "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch.
+          "api_key": "A String", # Required. The API key for ExaAiSearch.
+          "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch.
+          "api_key": "A String", # Optional. The API key for ParallelAiSearch.
+          "custom_config": { # Optional. Custom configs for ParallelAiSearch.
+            "a_key": "", # Properties of the object.
+          },
+        },
+        "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore.
+          "rag_resources": [ # Optional. The representation of the rag source.
+            { # The definition of the Rag resource.
+              "rag_corpus": "A String", # Optional. RagCorpora resource name.
+              "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.
+                "A String",
+              ],
+            },
+          ],
+          "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query.
+            "filter": { # Config for filters. # Optional. Config for filters.
+              "metadata_filter": "A String", # Optional. String for metadata filtering.
+              "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold.
+              "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold.
+            },
+            "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search.
+              "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results.
+            },
+            "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking.
+              "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service.
+                "model_name": "A String", # Optional. The model name of the rank service.
+              },
+            },
+            "top_k": 42, # Optional. The number of contexts to retrieve.
+          },
+          "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora.
+          "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold.
+        },
+        "retrievalTypes": [ # The types of file retrieval to enable.
+          "A String",
+        ],
+        "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch.
+          "datastores": [ # Optional. Used to specify Vertex AI Search datastores.
+            "A String",
+          ],
+          "engine": "A String", # Optional. Used to specify Vertex AI Search engine.
+        },
+      },
+      "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context.
+      },
+    },
+  ],
+  "turnList": { # A list of Turns. # The turns for the interaction.
+    "turns": [
+      {
+        "contentList": { # A list of Content. # The content of the turn. An array of Content objects.
+          "contents": [ # The contents of the list.
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeType": "A String", # The mime type of the audio.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeType": "A String", # The mime type of the document.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "thought": { # A thought content block.
+                "signature": "A String", # Signature to match the backend source to be part of the generation.
+                "summary": [ # A summary of the thought.
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "toolCall": { # Tool call content.
+                "codeExecutionCall": { # Code execution content.
+                  "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                    "code": "A String", # The code to be executed.
+                    "language": "A String", # Programming language of the `code`.
+                  },
+                },
+                "fileSearchCall": { # File Search content.
+                },
+                "functionCall": { # A function tool call content block.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                  "name": "A String", # Required. The name of the tool to call.
+                },
+                "googleMapsCall": { # Google Maps content.
+                  "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                    "queries": [ # The queries to be executed.
+                      "A String",
+                    ],
+                  },
+                },
+                "googleSearchCall": { # Google Search content.
+                  "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                    "queries": [ # Web search queries for the following-up web search.
+                      "A String",
+                    ],
+                  },
+                  "searchType": "A String", # The type of search grounding enabled.
+                },
+                "id": "A String", # Required. A unique ID for this specific tool call.
+                "mcpServerToolCall": { # MCPServer tool call content.
+                  "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                  "name": "A String", # Required. The name of the tool which was called.
+                  "serverName": "A String", # Required. The name of the used MCP server.
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextCall": { # URL context content.
+                  "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                    "urls": [ # The URLs to fetch.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "toolResult": { # Tool result content.
+                "callId": "A String", # Required. ID to match the ID from the function call block.
+                "codeExecutionResult": { # Code execution result content.
+                  "isError": True or False, # Whether the code execution resulted in an error.
+                  "result": "A String", # Required. The output of the code execution.
+                },
+                "fileSearchResult": { # File Search result content.
+                  "result": [ # Optional. The results of the File Search.
+                    { # The result of the File Search.
+                    },
+                  ],
+                },
+                "functionResult": { # A function tool result content block.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "isError": True or False, # Whether the tool call resulted in an error.
+                  "name": "A String", # The name of the tool that was called.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "googleMapsResult": { # Google Maps result content.
+                  "result": [ # Required. The results of the Google Maps.
+                    { # The result of the Google Maps.
+                      "places": [ # The places that were found.
+                        {
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                      ],
+                      "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                    },
+                  ],
+                },
+                "googleSearchResult": { # Google Search result content.
+                  "isError": True or False, # Whether the Google Search resulted in an error.
+                  "result": [ # Required. The results of the Google Search.
+                    { # The result of the Google Search.
+                      "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                    },
+                  ],
+                },
+                "mcpServerToolResult": { # MCPServer tool result content.
+                  "contentList": {
+                    "contents": [
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "name": "A String", # Name of the tool which is called for this specific tool call.
+                  "serverName": "A String", # The name of the used MCP server.
+                  "stringResult": "A String",
+                  "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                },
+                "signature": "A String", # A signature hash for backend validation.
+                "urlContextResult": { # URL context result content.
+                  "isError": True or False, # Whether the URL context resulted in an error.
+                  "result": [ # Required. The results of the URL context.
+                    { # The result of the URL context.
+                      "status": "A String", # The status of the URL retrieval.
+                      "url": "A String", # The URL that was fetched.
+                    },
+                  ],
+                },
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeType": "A String", # The mime type of the video.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+        },
+        "contentString": "A String", # The content of the turn. A single string.
+        "role": "A String", # The originator of this turn. Must be user for input or model for model output.
+      },
+    ],
+  },
+  "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
+  "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage.
+    "cachedTokensByModality": [ # A breakdown of cached token usage by modality.
+      { # The token count for a single response modality.
+        "modality": "A String", # The modality associated with the token count.
+        "tokens": 42, # Number of tokens for the modality.
+      },
+    ],
+    "groundingToolCount": [ # Grounding tool count.
+      { # The number of grounding tool counts.
+        "count": 42, # The number of grounding tool counts.
+        "type": "A String", # The grounding tool type associated with the count.
+      },
+    ],
+    "inputTokensByModality": [ # A breakdown of input token usage by modality.
+      { # The token count for a single response modality.
+        "modality": "A String", # The modality associated with the token count.
+        "tokens": 42, # Number of tokens for the modality.
+      },
+    ],
+    "outputTokensByModality": [ # A breakdown of output token usage by modality.
+      { # The token count for a single response modality.
+        "modality": "A String", # The modality associated with the token count.
+        "tokens": 42, # Number of tokens for the modality.
+      },
+    ],
+    "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality.
+      { # The token count for a single response modality.
+        "modality": "A String", # The modality associated with the token count.
+        "tokens": 42, # Number of tokens for the modality.
+      },
+    ],
+    "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content).
+    "totalInputTokens": 42, # Number of tokens in the prompt (context).
+    "totalOutputTokens": 42, # Total number of tokens across all the generated responses.
+    "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models.
+    "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens).
+    "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s).
+  },
+}
+
+ +
+ getStream(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) +
Fully typed proto, streaming version of GetInteraction that returns Interaction proto.
+
+Args:
+  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
+  includeInput: boolean, Optional. If true, includes the input in the response.
+  lastEventId: string, Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
+  stream: boolean, Optional. If true, streams the interaction events as Server-Sent Events.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "contentDelta": { # The content block delta data, used for content.delta events.
+    "delta": { # The delta content data for a content block.
+      "audio": {
+        "channels": 42, # The number of audio channels.
+        "data": "A String",
+        "mimeType": "A String",
+        "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored.
+        "sampleRate": 42, # The sample rate of the audio.
+        "uri": "A String",
+      },
+      "document": {
+        "data": "A String",
+        "mimeType": "A String",
+        "uri": "A String",
+      },
+      "image": {
+        "data": "A String",
+        "mimeType": "A String",
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String",
+      },
+      "text": {
+        "text": "A String",
+      },
+      "textAnnotation": {
+        "annotations": [ # Citation information for model-generated content.
+          { # Citation information for model-generated content.
+            "endIndex": 42, # End of the attributed segment, exclusive.
+            "fileCitation": { # A file citation annotation. # A file citation annotation.
+              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+              "documentUri": "A String", # The URI of the file.
+              "fileName": "A String", # The name of the file.
+              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+              "pageNumber": 42, # Page number of the cited document, if applicable.
+              "source": "A String", # Source attributed for a portion of the text.
+            },
+            "placeCitation": { # A place citation annotation. # A place citation annotation.
+              "name": "A String", # Title of the place.
+              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                  "reviewId": "A String", # The ID of the review snippet.
+                  "title": "A String", # Title of the review.
+                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                },
+              ],
+              "url": "A String", # URI reference of the place.
+            },
+            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+              "title": "A String", # The title of the URL.
+              "url": "A String", # The URL.
+            },
+          },
+        ],
+      },
+      "thoughtSignature": {
+        "signature": "A String", # Signature to match the backend source to be part of the generation.
+      },
+      "thoughtSummary": {
+        "content": { # The content of the response. # A new summary item to be added to the thought.
+          "audio": { # An audio content block.
+            "channels": 42, # The number of audio channels.
+            "data": "A String", # The audio content.
+            "mimeType": "A String", # The mime type of the audio.
+            "sampleRate": 42, # The sample rate of the audio.
+            "uri": "A String", # The URI of the audio.
+          },
+          "document": { # A document content block.
+            "data": "A String", # The document content.
+            "mimeType": "A String", # The mime type of the document.
+            "uri": "A String", # The URI of the document.
+          },
+          "image": { # An image content block.
+            "data": "A String", # The image content.
+            "mimeType": "A String", # The mime type of the image.
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String", # The URI of the image.
+          },
+          "text": { # A text content block.
+            "annotations": [ # Citation information for model-generated content.
+              { # Citation information for model-generated content.
+                "endIndex": 42, # End of the attributed segment, exclusive.
+                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                  "documentUri": "A String", # The URI of the file.
+                  "fileName": "A String", # The name of the file.
+                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                  "source": "A String", # Source attributed for a portion of the text.
+                },
+                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                  "title": "A String", # The title of the URL.
+                  "url": "A String", # The URL.
+                },
+              },
+            ],
+            "text": "A String", # Required. The text content.
+          },
+          "thought": { # A thought content block.
+            "signature": "A String", # Signature to match the backend source to be part of the generation.
+            "summary": [ # A summary of the thought.
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "toolCall": { # Tool call content.
+            "codeExecutionCall": { # Code execution content.
+              "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                "code": "A String", # The code to be executed.
+                "language": "A String", # Programming language of the `code`.
+              },
+            },
+            "fileSearchCall": { # File Search content.
+            },
+            "functionCall": { # A function tool call content block.
+              "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+              "name": "A String", # Required. The name of the tool to call.
+            },
+            "googleMapsCall": { # Google Maps content.
+              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                "queries": [ # The queries to be executed.
+                  "A String",
+                ],
+              },
+            },
+            "googleSearchCall": { # Google Search content.
+              "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                "queries": [ # Web search queries for the following-up web search.
+                  "A String",
+                ],
+              },
+              "searchType": "A String", # The type of search grounding enabled.
+            },
+            "id": "A String", # Required. A unique ID for this specific tool call.
+            "mcpServerToolCall": { # MCPServer tool call content.
+              "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+              "name": "A String", # Required. The name of the tool which was called.
+              "serverName": "A String", # Required. The name of the used MCP server.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextCall": { # URL context content.
+              "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                "urls": [ # The URLs to fetch.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "toolResult": { # Tool result content.
+            "callId": "A String", # Required. ID to match the ID from the function call block.
+            "codeExecutionResult": { # Code execution result content.
+              "isError": True or False, # Whether the code execution resulted in an error.
+              "result": "A String", # Required. The output of the code execution.
+            },
+            "fileSearchResult": { # File Search result content.
+              "result": [ # Optional. The results of the File Search.
+                { # The result of the File Search.
+                },
+              ],
+            },
+            "functionResult": { # A function tool result content block.
+              "contentList": {
+                "contents": [
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "isError": True or False, # Whether the tool call resulted in an error.
+              "name": "A String", # The name of the tool that was called.
+              "stringResult": "A String",
+              "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+            },
+            "googleMapsResult": { # Google Maps result content.
+              "result": [ # Required. The results of the Google Maps.
+                { # The result of the Google Maps.
+                  "places": [ # The places that were found.
+                    {
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                  ],
+                  "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                },
+              ],
+            },
+            "googleSearchResult": { # Google Search result content.
+              "isError": True or False, # Whether the Google Search resulted in an error.
+              "result": [ # Required. The results of the Google Search.
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                },
+              ],
+            },
+            "mcpServerToolResult": { # MCPServer tool result content.
+              "contentList": {
+                "contents": [
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Name of the tool which is called for this specific tool call.
+              "serverName": "A String", # The name of the used MCP server.
+              "stringResult": "A String",
+              "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextResult": { # URL context result content.
+              "isError": True or False, # Whether the URL context resulted in an error.
+              "result": [ # Required. The results of the URL context.
+                { # The result of the URL context.
+                  "status": "A String", # The status of the URL retrieval.
+                  "url": "A String", # The URL that was fetched.
+                },
+              ],
+            },
+          },
+          "video": { # A video content block.
+            "data": "A String", # The video content.
+            "mimeType": "A String", # The mime type of the video.
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String", # The URI of the video.
+          },
+        },
+      },
+      "toolCall": {
+        "codeExecutionCall": {
+          "arguments": { # The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": {
+        },
+        "functionCall": {
+          "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+          "name": "A String",
+        },
+        "googleMapsCall": {
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": {
+          "arguments": { # The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": {
+          "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+          "name": "A String",
+          "serverName": "A String",
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": {
+          "arguments": { # The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
+        },
+      },
+      "toolResult": {
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": {
+          "isError": True or False,
+          "result": "A String",
+        },
+        "fileSearchResult": {
+          "result": [
+            { # The result of the File Search.
+            },
+          ],
+        },
+        "functionResult": {
+          "contentList": { # A list of Content.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "isError": True or False,
+          "name": "A String",
+          "stringResult": "A String",
+          "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+        },
+        "googleMapsResult": {
+          "result": [ # The results of the Google Maps.
+            { # The result of the Google Maps.
+              "places": [ # The places that were found.
+                {
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+              ],
+              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+            },
+          ],
+        },
+        "googleSearchResult": {
+          "isError": True or False,
+          "result": [
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": {
+          "contentList": { # A list of Content.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "name": "A String",
+          "serverName": "A String",
+          "stringResult": "A String",
+          "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": {
+          "isError": True or False,
+          "result": [
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
+            },
+          ],
+        },
+      },
+      "video": {
+        "data": "A String",
+        "mimeType": "A String",
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String",
+      },
+    },
+    "index": 42,
+  },
+  "contentStart": { # The content block start data, used for content.start events.
+    "content": { # The content of the response.
+      "audio": { # An audio content block.
+        "channels": 42, # The number of audio channels.
+        "data": "A String", # The audio content.
+        "mimeType": "A String", # The mime type of the audio.
+        "sampleRate": 42, # The sample rate of the audio.
+        "uri": "A String", # The URI of the audio.
+      },
+      "document": { # A document content block.
+        "data": "A String", # The document content.
+        "mimeType": "A String", # The mime type of the document.
+        "uri": "A String", # The URI of the document.
+      },
+      "image": { # An image content block.
+        "data": "A String", # The image content.
+        "mimeType": "A String", # The mime type of the image.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the image.
+      },
+      "text": { # A text content block.
+        "annotations": [ # Citation information for model-generated content.
+          { # Citation information for model-generated content.
+            "endIndex": 42, # End of the attributed segment, exclusive.
+            "fileCitation": { # A file citation annotation. # A file citation annotation.
+              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+              "documentUri": "A String", # The URI of the file.
+              "fileName": "A String", # The name of the file.
+              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+              "pageNumber": 42, # Page number of the cited document, if applicable.
+              "source": "A String", # Source attributed for a portion of the text.
+            },
+            "placeCitation": { # A place citation annotation. # A place citation annotation.
+              "name": "A String", # Title of the place.
+              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                  "reviewId": "A String", # The ID of the review snippet.
+                  "title": "A String", # Title of the review.
+                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                },
+              ],
+              "url": "A String", # URI reference of the place.
+            },
+            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+              "title": "A String", # The title of the URL.
+              "url": "A String", # The URL.
+            },
+          },
+        ],
+        "text": "A String", # Required. The text content.
+      },
+      "thought": { # A thought content block.
+        "signature": "A String", # Signature to match the backend source to be part of the generation.
+        "summary": [ # A summary of the thought.
+          {
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+          },
+        ],
+      },
+      "toolCall": { # Tool call content.
+        "codeExecutionCall": { # Code execution content.
+          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": { # File Search content.
+        },
+        "functionCall": { # A function tool call content block.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+          "name": "A String", # Required. The name of the tool to call.
+        },
+        "googleMapsCall": { # Google Maps content.
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": { # Google Search content.
+          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+          "searchType": "A String", # The type of search grounding enabled.
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": { # MCPServer tool call content.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+          "name": "A String", # Required. The name of the tool which was called.
+          "serverName": "A String", # Required. The name of the used MCP server.
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": { # URL context content.
+          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
         },
-        "searchType": "A String", # The type of search grounding enabled.
       },
-      "id": "A String", # Required. A unique ID for this specific tool call.
-      "mcpServerToolCall": { # MCPServer tool call content.
-        "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
+      "toolResult": { # Tool result content.
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": { # Code execution result content.
+          "isError": True or False, # Whether the code execution resulted in an error.
+          "result": "A String", # Required. The output of the code execution.
+        },
+        "fileSearchResult": { # File Search result content.
+          "result": [ # Optional. The results of the File Search.
+            { # The result of the File Search.
+            },
+          ],
+        },
+        "functionResult": { # A function tool result content block.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "isError": True or False, # Whether the tool call resulted in an error.
+          "name": "A String", # The name of the tool that was called.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "googleMapsResult": { # Google Maps result content.
+          "result": [ # Required. The results of the Google Maps.
+            { # The result of the Google Maps.
+              "places": [ # The places that were found.
+                {
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+              ],
+              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+            },
+          ],
+        },
+        "googleSearchResult": { # Google Search result content.
+          "isError": True or False, # Whether the Google Search resulted in an error.
+          "result": [ # Required. The results of the Google Search.
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": { # MCPServer tool result content.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
                   ],
+                  "text": "A String", # Required. The text content.
                 },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
               },
+            ],
+          },
+          "name": "A String", # Name of the tool which is called for this specific tool call.
+          "serverName": "A String", # The name of the used MCP server.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": { # URL context result content.
+          "isError": True or False, # Whether the URL context resulted in an error.
+          "result": [ # Required. The results of the URL context.
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
             },
           ],
         },
-        "name": "A String", # Required. The name of the tool which was called.
-        "serverName": "A String", # Required. The name of the used MCP server.
       },
-      "signature": "A String", # A signature hash for backend validation.
-      "urlContextCall": { # URL context content.
-        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
-          "urls": [ # The URLs to fetch.
-            "A String",
-          ],
-        },
+      "video": { # A video content block.
+        "data": "A String", # The video content.
+        "mimeType": "A String", # The mime type of the video.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the video.
       },
     },
-    "toolResult": { # Tool result content.
-      "callId": "A String", # Required. ID to match the ID from the function call block.
-      "codeExecutionResult": { # Code execution result content.
-        "isError": True or False, # Whether the code execution resulted in an error.
-        "result": "A String", # Required. The output of the code execution.
-      },
-      "fileSearchResult": { # File Search result content.
-        "result": [ # Optional. The results of the File Search.
-          { # The result of the File Search.
-          },
-        ],
-      },
-      "functionResult": { # A function tool result content block.
-        "contentList": {
-          "contents": [
-            {
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeType": "A String", # The mime type of the image.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                          { # Represents a single field in a struct.
-                            "name": "A String",
-                            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                              "boolValue": True or False, # Represents a boolean value.
-                              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                "values": [ # Repeated field of dynamically typed values.
-                                  # Object with schema name: GenaiVertexV1beta1Value
-                                ],
+    "index": 42,
+  },
+  "contentStop": { # The content block stop data, used for content.stop events.
+    "index": 42,
+  },
+  "errorEvent": { # The error event data, used for error events.
+    "error": { # Error message from an interaction.
+      "code": "A String", # A URI that identifies the error type.
+      "message": "A String", # A human-readable error message.
+    },
+  },
+  "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event.
+  "interactionCompleteEvent": { # The interaction data, used for interaction.complete events.
+    "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output.
+      "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents.
+        "agent": "A String", # The name of the `Agent` used for generating the completion.
+        "deepResearchConfig": { # Configuration for the Deep Research agent.
+          "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
+          "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent.
+          "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
+          "visualization": "A String", # Whether to include visualizations in the response.
+        },
+        "dynamicConfig": { # Configuration for dynamic agents.
+          "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition.
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
                               },
-                              "nullValue": "A String", # Represents a null value.
-                              "numberValue": 3.14, # Represents a double value.
-                              "stringValue": "A String", # Represents a string value.
-                              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                            },
+                            ],
+                            "url": "A String", # URI reference of the place.
                           },
-                        ],
-                      },
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
                     },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
                         },
                       ],
-                      "url": "A String", # URI reference of the place.
                     },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
                     },
-                  },
-                ],
-                "text": "A String", # Required. The text content.
-              },
-            },
-          ],
-        },
-        "isError": True or False, # Whether the tool call resulted in an error.
-        "name": "A String", # The name of the tool that was called.
-        "stringResult": "A String",
-        "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
-                  ],
-                },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-              },
-            },
-          ],
-        },
-      },
-      "googleMapsResult": { # Google Maps result content.
-        "result": [ # Required. The results of the Google Maps.
-          { # The result of the Google Maps.
-            "places": [ # The places that were found.
-              {
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-            ],
-            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
-          },
-        ],
-      },
-      "googleSearchResult": { # Google Search result content.
-        "isError": True or False, # Whether the Google Search resulted in an error.
-        "result": [ # Required. The results of the Google Search.
-          { # The result of the Google Search.
-            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
-          },
-        ],
-      },
-      "mcpServerToolResult": { # MCPServer tool result content.
-        "contentList": {
-          "contents": [
-            {
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeType": "A String", # The mime type of the image.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                          { # Represents a single field in a struct.
-                            "name": "A String",
-                            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                              "boolValue": True or False, # Represents a boolean value.
-                              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                "values": [ # Repeated field of dynamically typed values.
-                                  # Object with schema name: GenaiVertexV1beta1Value
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
                                 ],
+                                "text": "A String", # Required. The text content.
                               },
-                              "nullValue": "A String", # Represents a null value.
-                              "numberValue": 3.14, # Represents a double value.
-                              "stringValue": "A String", # Represents a string value.
-                              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                             },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
                           },
                         ],
                       },
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
                         },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
                     },
-                  },
-                ],
-                "text": "A String", # Required. The text content.
-              },
-            },
-          ],
-        },
-        "name": "A String", # Name of the tool which is called for this specific tool call.
-        "serverName": "A String", # The name of the used MCP server.
-        "stringResult": "A String",
-        "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
-                  ],
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                 },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
               },
-            },
-          ],
-        },
-      },
-      "signature": "A String", # A signature hash for backend validation.
-      "urlContextResult": { # URL context result content.
-        "isError": True or False, # Whether the URL context resulted in an error.
-        "result": [ # Required. The results of the URL context.
-          { # The result of the URL context.
-            "status": "A String", # The status of the URL retrieval.
-            "url": "A String", # The URL that was fetched.
+            ],
           },
-        ],
+        },
       },
-    },
-    "video": { # A video content block.
-      "data": "A String", # The video content.
-      "mimeType": "A String", # The mime type of the video.
-      "resolution": "A String", # The resolution of the media.
-      "uri": "A String", # The URI of the video.
-    },
-  },
-  "contentList": { # A list of Content. # The inputs for the interaction.
-    "contents": [ # The contents of the list.
-      { # The content of the response.
+      "content": { # The content of the response. # The content for the interaction.
         "audio": { # An audio content block.
           "channels": 42, # The number of audio channels.
           "data": "A String", # The audio content.
@@ -7681,25 +22394,7 @@ 

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -7742,25 +22437,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -7801,25 +22478,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -7839,25 +22498,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -7897,25 +22538,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -7949,25 +22572,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -8013,25 +22618,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8065,25 +22652,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -8103,124 +22672,21 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -8232,25 +22698,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8266,115 +22714,370 @@

Method Details

"title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "text": "A String", # Required. The text content. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -8387,25 +23090,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8436,34 +23121,268 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -8475,22 +23394,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -8503,25 +23418,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8552,258 +23449,117 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -8815,18 +23571,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -8839,150 +23599,427 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -8994,25 +24031,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9040,37 +24059,330 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -9082,22 +24394,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -9110,25 +24418,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9159,126 +24449,244 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -9290,25 +24698,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9336,141 +24726,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -9482,46 +24894,152 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -9533,22 +25051,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -9561,25 +25075,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9610,139 +25106,224 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], + "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. + }, }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -9767,25 +25348,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9828,25 +25391,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9887,25 +25432,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -9925,25 +25452,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -9983,25 +25492,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10035,25 +25526,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -10099,25 +25572,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10151,25 +25606,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -10191,378 +25628,732 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "fileSearchCall": { # File Search call step. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -10574,22 +26365,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -10602,25 +26389,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10651,352 +26420,117 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "fileSearchCall": { # File Search content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -11008,74 +26542,112 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -11087,25 +26659,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -11133,359 +26687,256 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -11500,28 +26951,28 @@

Method Details

], }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ { # The result of the Google Maps. - "places": [ # The places that were found. + "places": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "widgetContextToken": "A String", }, ], }, - "googleSearchResult": { # Google Search result content. + "googleSearchResult": { # Google Search result step. "isError": True or False, # Whether the Google Search resulted in an error. "result": [ # Required. The results of the Google Search. { # The result of the Google Search. @@ -11529,10 +26980,22 @@

Method Details

}, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -11544,25 +27007,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -11590,6 +27035,255 @@

Method Details

], "text": "A String", # Required. The text content. }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, @@ -11602,6 +27296,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -11617,7 +27613,7 @@

Method Details

}, }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. + "urlContextResult": { # URL context result step. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -11627,556 +27623,322 @@

Method Details

], }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "contentString": "A String", # The content of the step. A single string. }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -12201,25 +27963,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12262,25 +28006,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12321,25 +28047,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -12359,25 +28067,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -12417,25 +28107,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12469,25 +28141,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -12533,25 +28187,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12585,25 +28221,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -12624,62 +28242,19 @@

Method Details

}, }, ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ + "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. { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", + "a_key": "", # Properties of the object. Contains field @type with type URL. }, ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "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. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -12704,25 +28279,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12765,25 +28322,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12824,25 +28363,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -12862,25 +28383,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -12920,25 +28423,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12972,25 +28457,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -13036,25 +28503,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13077,323 +28526,68 @@

Method Details

"urlCitation": { # A URL citation annotation. # A URL citation annotation. "title": "A String", # The title of the URL. "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -13405,25 +28599,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13451,65 +28627,307 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -13521,25 +28939,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13548,270 +28948,324 @@

Method Details

}, "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -13823,25 +29277,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13869,141 +29305,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -14015,74 +29473,112 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -14094,25 +29590,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14140,424 +29618,315 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, -}
-
- -
- getStream(name, includeInput=None, lastEventId=None, stream=None, x__xgafv=None) -
Fully typed proto, streaming version of GetInteraction that returns Interaction proto.
-
-Args:
-  name: string, Required. The name of the interaction to retrieve. Format: interactions/{interaction} (required)
-  includeInput: boolean, Optional. If true, includes the input in the response.
-  lastEventId: string, Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.
-  stream: boolean, Optional. If true, streams the interaction events as Server-Sent Events.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "contentDelta": { # The content block delta data, used for content.delta events.
-    "delta": { # The delta content data for a content block.
-      "audio": {
-        "channels": 42, # The number of audio channels.
-        "data": "A String",
-        "mimeType": "A String",
-        "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored.
-        "sampleRate": 42, # The sample rate of the audio.
-        "uri": "A String",
-      },
-      "document": {
-        "data": "A String",
-        "mimeType": "A String",
-        "uri": "A String",
-      },
-      "image": {
-        "data": "A String",
-        "mimeType": "A String",
-        "resolution": "A String", # The resolution of the media.
-        "uri": "A String",
-      },
-      "text": {
-        "text": "A String",
-      },
-      "textAnnotation": {
-        "annotations": [ # Citation information for model-generated content.
-          { # Citation information for model-generated content.
-            "endIndex": 42, # End of the attributed segment, exclusive.
-            "fileCitation": { # A file citation annotation. # A file citation annotation.
-              "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                  { # Represents a single field in a struct.
-                    "name": "A String",
-                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                      "boolValue": True or False, # Represents a boolean value.
-                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                        "values": [ # Repeated field of dynamically typed values.
-                          # Object with schema name: GenaiVertexV1beta1Value
-                        ],
-                      },
-                      "nullValue": "A String", # Represents a null value.
-                      "numberValue": 3.14, # Represents a double value.
-                      "stringValue": "A String", # Represents a string value.
-                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                    },
-                  },
-                ],
-              },
-              "documentUri": "A String", # The URI of the file.
-              "fileName": "A String", # The name of the file.
-              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-              "pageNumber": 42, # Page number of the cited document, if applicable.
-              "source": "A String", # Source attributed for a portion of the text.
-            },
-            "placeCitation": { # A place citation annotation. # A place citation annotation.
-              "name": "A String", # Title of the place.
-              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                  "reviewId": "A String", # The ID of the review snippet.
-                  "title": "A String", # Title of the review.
-                  "url": "A String", # A link that corresponds to the user review on Google Maps.
-                },
-              ],
-              "url": "A String", # URI reference of the place.
-            },
-            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-              "title": "A String", # The title of the URL.
-              "url": "A String", # The URL.
-            },
-          },
-        ],
-      },
-      "thoughtSignature": {
-        "signature": "A String", # Signature to match the backend source to be part of the generation.
-      },
-      "thoughtSummary": {
-        "content": { # The content of the response. # A new summary item to be added to the thought.
-          "audio": { # An audio content block.
-            "channels": 42, # The number of audio channels.
-            "data": "A String", # The audio content.
-            "mimeType": "A String", # The mime type of the audio.
-            "sampleRate": 42, # The sample rate of the audio.
-            "uri": "A String", # The URI of the audio.
-          },
-          "document": { # A document content block.
-            "data": "A String", # The document content.
-            "mimeType": "A String", # The mime type of the document.
-            "uri": "A String", # The URI of the document.
-          },
-          "image": { # An image content block.
-            "data": "A String", # The image content.
-            "mimeType": "A String", # The mime type of the image.
-            "resolution": "A String", # The resolution of the media.
-            "uri": "A String", # The URI of the image.
-          },
-          "text": { # A text content block.
-            "annotations": [ # Citation information for model-generated content.
-              { # Citation information for model-generated content.
-                "endIndex": 42, # End of the attributed segment, exclusive.
-                "fileCitation": { # A file citation annotation. # A file citation annotation.
-                  "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                    "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                      { # Represents a single field in a struct.
-                        "name": "A String",
-                        "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                          "boolValue": True or False, # Represents a boolean value.
-                          "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                            "values": [ # Repeated field of dynamically typed values.
-                              # Object with schema name: GenaiVertexV1beta1Value
+                        "toolResult": { # Tool result content.
+                          "callId": "A String", # Required. ID to match the ID from the function call block.
+                          "codeExecutionResult": { # Code execution result content.
+                            "isError": True or False, # Whether the code execution resulted in an error.
+                            "result": "A String", # Required. The output of the code execution.
+                          },
+                          "fileSearchResult": { # File Search result content.
+                            "result": [ # Optional. The results of the File Search.
+                              { # The result of the File Search.
+                              },
                             ],
                           },
-                          "nullValue": "A String", # Represents a null value.
-                          "numberValue": 3.14, # Represents a double value.
-                          "stringValue": "A String", # Represents a string value.
-                          "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                        },
-                      },
-                    ],
-                  },
-                  "documentUri": "A String", # The URI of the file.
-                  "fileName": "A String", # The name of the file.
-                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                  "pageNumber": 42, # Page number of the cited document, if applicable.
-                  "source": "A String", # Source attributed for a portion of the text.
-                },
-                "placeCitation": { # A place citation annotation. # A place citation annotation.
-                  "name": "A String", # Title of the place.
-                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                      "reviewId": "A String", # The ID of the review snippet.
-                      "title": "A String", # Title of the review.
-                      "url": "A String", # A link that corresponds to the user review on Google Maps.
-                    },
-                  ],
-                  "url": "A String", # URI reference of the place.
-                },
-                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                  "title": "A String", # The title of the URL.
-                  "url": "A String", # The URL.
-                },
-              },
-            ],
-            "text": "A String", # Required. The text content.
-          },
-          "thought": { # A thought content block.
-            "signature": "A String", # Signature to match the backend source to be part of the generation.
-            "summary": [ # A summary of the thought.
-              {
-                "image": { # An image content block.
-                  "data": "A String", # The image content.
-                  "mimeType": "A String", # The mime type of the image.
-                  "resolution": "A String", # The resolution of the media.
-                  "uri": "A String", # The URI of the image.
-                },
-                "text": { # A text content block.
-                  "annotations": [ # Citation information for model-generated content.
-                    { # Citation information for model-generated content.
-                      "endIndex": 42, # End of the attributed segment, exclusive.
-                      "fileCitation": { # A file citation annotation. # A file citation annotation.
-                        "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                            { # Represents a single field in a struct.
-                              "name": "A String",
-                              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                                "boolValue": True or False, # Represents a boolean value.
-                                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                  "values": [ # Repeated field of dynamically typed values.
-                                    # Object with schema name: GenaiVertexV1beta1Value
-                                  ],
+                          "functionResult": { # A function tool result content block.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
                                 },
-                                "nullValue": "A String", # Represents a null value.
-                                "numberValue": 3.14, # Represents a double value.
-                                "stringValue": "A String", # Represents a string value.
-                                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                              ],
+                            },
+                            "isError": True or False, # Whether the tool call resulted in an error.
+                            "name": "A String", # The name of the tool that was called.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "googleMapsResult": { # Google Maps result content.
+                            "result": [ # Required. The results of the Google Maps.
+                              { # The result of the Google Maps.
+                                "places": [ # The places that were found.
+                                  {
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                ],
+                                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                              },
+                            ],
+                          },
+                          "googleSearchResult": { # Google Search result content.
+                            "isError": True or False, # Whether the Google Search resulted in an error.
+                            "result": [ # Required. The results of the Google Search.
+                              { # The result of the Google Search.
+                                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
                               },
+                            ],
+                          },
+                          "mcpServerToolResult": { # MCPServer tool result content.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
                             },
-                          ],
-                        },
-                        "documentUri": "A String", # The URI of the file.
-                        "fileName": "A String", # The name of the file.
-                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                        "pageNumber": 42, # Page number of the cited document, if applicable.
-                        "source": "A String", # Source attributed for a portion of the text.
-                      },
-                      "placeCitation": { # A place citation annotation. # A place citation annotation.
-                        "name": "A String", # Title of the place.
-                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                            "reviewId": "A String", # The ID of the review snippet.
-                            "title": "A String", # Title of the review.
-                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            "name": "A String", # Name of the tool which is called for this specific tool call.
+                            "serverName": "A String", # The name of the used MCP server.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
                           },
-                        ],
-                        "url": "A String", # URI reference of the place.
-                      },
-                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                        "title": "A String", # The title of the URL.
-                        "url": "A String", # The URL.
-                      },
-                    },
-                  ],
-                  "text": "A String", # Required. The text content.
-                },
-              },
-            ],
-          },
-          "toolCall": { # Tool call content.
-            "codeExecutionCall": { # Code execution content.
-              "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
-                "code": "A String", # The code to be executed.
-                "language": "A String", # Programming language of the `code`.
-              },
-            },
-            "fileSearchCall": { # File Search content.
-            },
-            "functionCall": { # A function tool call content block.
-              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
-                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                  { # Represents a single field in a struct.
-                    "name": "A String",
-                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                      "boolValue": True or False, # Represents a boolean value.
-                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                        "values": [ # Repeated field of dynamically typed values.
-                          # Object with schema name: GenaiVertexV1beta1Value
-                        ],
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextResult": { # URL context result content.
+                            "isError": True or False, # Whether the URL context resulted in an error.
+                            "result": [ # Required. The results of the URL context.
+                              { # The result of the URL context.
+                                "status": "A String", # The status of the URL retrieval.
+                                "url": "A String", # The URL that was fetched.
+                              },
+                            ],
+                          },
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeType": "A String", # The mime type of the video.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
                       },
-                      "nullValue": "A String", # Represents a null value.
-                      "numberValue": 3.14, # Represents a double value.
-                      "stringValue": "A String", # Represents a string value.
-                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                    },
-                  },
-                ],
-              },
-              "name": "A String", # Required. The name of the tool to call.
-            },
-            "googleMapsCall": { # Google Maps content.
-              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
-                "queries": [ # The queries to be executed.
-                  "A String",
-                ],
-              },
-            },
-            "googleSearchCall": { # Google Search content.
-              "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
-                "queries": [ # Web search queries for the following-up web search.
-                  "A String",
-                ],
-              },
-              "searchType": "A String", # The type of search grounding enabled.
-            },
-            "id": "A String", # Required. A unique ID for this specific tool call.
-            "mcpServerToolCall": { # MCPServer tool call content.
-              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
-                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                  { # Represents a single field in a struct.
-                    "name": "A String",
-                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                      "boolValue": True or False, # Represents a boolean value.
                       "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
                         "values": [ # Repeated field of dynamically typed values.
                           # Object with schema name: GenaiVertexV1beta1Value
                         ],
                       },
-                      "nullValue": "A String", # Represents a null value.
-                      "numberValue": 3.14, # Represents a double value.
-                      "stringValue": "A String", # Represents a string value.
-                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                    },
-                  },
-                ],
-              },
-              "name": "A String", # Required. The name of the tool which was called.
-              "serverName": "A String", # Required. The name of the used MCP server.
-            },
-            "signature": "A String", # A signature hash for backend validation.
-            "urlContextCall": { # URL context content.
-              "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
-                "urls": [ # The URLs to fetch.
-                  "A String",
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                    },
+                  },
                 ],
               },
             },
-          },
-          "toolResult": { # Tool result content.
-            "callId": "A String", # Required. ID to match the ID from the function call block.
-            "codeExecutionResult": { # Code execution result content.
-              "isError": True or False, # Whether the code execution resulted in an error.
-              "result": "A String", # Required. The output of the code execution.
+            "googleMapsResult": { # Google Maps result step.
+              "result": [
+                { # The result of the Google Maps.
+                  "places": [
+                    {
+                      "name": "A String",
+                      "placeId": "A String",
+                      "reviewSnippets": [
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String",
+                    },
+                  ],
+                  "widgetContextToken": "A String",
+                },
+              ],
             },
-            "fileSearchResult": { # File Search result content.
-              "result": [ # Optional. The results of the File Search.
-                { # The result of the File Search.
+            "googleSearchResult": { # Google Search result step.
+              "isError": True or False, # Whether the Google Search resulted in an error.
+              "result": [ # Required. The results of the Google Search.
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
                 },
               ],
             },
-            "functionResult": { # A function tool result content block.
-              "contentList": {
-                "contents": [
-                  {
+            "mcpServerToolResult": { # MCPServer tool result step.
+              "contentList": { # A list of Content.
+                "contents": [ # The contents of the list.
+                  { # The content of the response.
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
                     "image": { # An image content block.
                       "data": "A String", # The image content.
                       "mimeType": "A String", # The mime type of the image.
@@ -14569,25 +29938,7 @@ 

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14615,11 +29966,260 @@

Method Details

], "text": "A String", # Required. The text content. }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. @@ -14627,122 +30227,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -14758,7 +30544,7 @@

Method Details

}, }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. + "urlContextResult": { # URL context result step. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -14768,108 +30554,346 @@

Method Details

], }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - }, - "toolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { - }, - "functionCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, - "name": "A String", }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. "A String", ], - }, - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", ], }, - "name": "A String", - "serverName": "A String", - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { - "arguments": { # The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. "A String", ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - }, - }, - "toolResult": { - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { - "isError": True or False, - "result": "A String", - }, - "fileSearchResult": { - "result": [ - { # The result of the File Search. - }, - ], - }, - "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -14893,25 +30917,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14954,25 +30960,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15013,25 +31001,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -15051,25 +31021,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -15109,25 +31061,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15161,25 +31095,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -15225,25 +31141,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15277,25 +31175,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -15315,174 +31195,311 @@

Method Details

"uri": "A String", # The URI of the video. }, }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. }, - ], - }, - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { - "isError": True or False, - "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -15494,112 +31511,208 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -15612,25 +31725,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15661,283 +31756,542 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { - "isError": True or False, - "result": [ - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "contentStart": { # The content block start data, used for content.start events. - "content": { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -15949,25 +32303,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15995,141 +32331,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -16141,46 +32499,167 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -16192,22 +32671,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -16220,25 +32695,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -16260,865 +32717,320 @@

Method Details

"startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. "urlCitation": { # A URL citation annotation. # A URL citation annotation. "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "index": 42, - }, - "contentStop": { # The content block stop data, used for content.stop events. - "index": 42, - }, - "errorEvent": { # The error event data, used for error events. - "error": { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - }, - "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. - "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. + }, + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "fileSearchCall": { # File Search content. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. + }, + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17130,23 +33042,266 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17155,28 +33310,10 @@

Method Details

}, "text": { # A text content block. "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17204,244 +33341,579 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", + }, ], }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -17455,188 +33927,371 @@

Method Details

}, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -17648,25 +34303,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17694,185 +34331,256 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -17887,6 +34595,12 @@

Method Details

], }, }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). @@ -17923,25 +34637,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17984,25 +34680,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18043,25 +34721,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -18081,25 +34741,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -18139,25 +34781,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18191,25 +34815,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -18252,28 +34858,10 @@

Method Details

}, "text": { # A text content block. "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18307,25 +34895,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -18346,6 +34916,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -18374,25 +34953,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18435,25 +34996,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18494,25 +35037,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -18532,25 +35057,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -18590,25 +35097,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18642,25 +35131,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -18706,25 +35177,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18758,25 +35211,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -18814,6 +35249,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -18852,6 +35589,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -18912,25 +35951,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18973,25 +35994,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19032,25 +36035,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -19070,25 +36055,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -19128,25 +36095,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19180,25 +36129,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -19244,25 +36175,139 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19293,58 +36338,210 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -19415,25 +36612,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19476,25 +36655,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19535,25 +36696,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -19573,25 +36716,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -19631,25 +36756,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19683,25 +36790,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -19747,25 +36836,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19799,25 +36870,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -19848,6 +36901,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -19900,25 +37255,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19961,25 +37298,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20020,25 +37339,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -20058,25 +37359,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -20116,25 +37399,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20168,25 +37433,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -20232,25 +37479,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20284,25 +37513,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -20357,25 +37568,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20418,25 +37611,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20477,25 +37652,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -20515,25 +37672,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -20573,25 +37712,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20625,25 +37746,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -20689,25 +37792,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20741,25 +37826,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -20780,6 +37847,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -20808,25 +37884,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20869,25 +37927,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20928,25 +37968,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -20966,25 +37988,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -21024,25 +38028,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21076,25 +38062,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -21140,25 +38108,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21192,25 +38142,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -21248,6 +38180,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -21286,6 +38520,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -21346,25 +38882,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21407,25 +38925,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21466,25 +38966,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -21504,25 +38986,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -21562,25 +39026,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21614,25 +39060,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -21678,25 +39106,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21730,25 +39140,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -21779,6 +39171,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -21849,25 +39543,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21910,25 +39586,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21969,25 +39627,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -22007,25 +39647,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -22065,25 +39687,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22117,25 +39721,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -22181,25 +39767,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22233,25 +39801,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -22282,108 +39832,19 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -22395,25 +39856,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22441,257 +39884,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -22703,185 +40052,115 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", ], }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. @@ -22907,25 +40186,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22968,25 +40229,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23027,25 +40270,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -23065,25 +40290,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -23123,25 +40330,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23175,25 +40364,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -23239,25 +40410,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23291,25 +40444,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -23331,606 +40466,449 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "contentString": "A String", # The content of the step. A single string. }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. }, }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", ], - "text": "A String", # Required. The text content. + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -23942,25 +40920,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23988,257 +40948,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -24250,448 +41116,166 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCreatedEvent": { # The interaction data, used for interaction.created events. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -24703,25 +41287,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -24749,224 +41315,428 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. + ], }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -24978,25 +41748,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25024,400 +41776,170 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -25429,25 +41951,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25475,423 +41979,30 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. "code": "A String", # The code to be executed. "language": "A String", # Programming language of the `code`. }, }, - "fileSearchCall": { # File Search call step. + "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps call step. + "googleMapsCall": { # Google Maps content. "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. "queries": [ # The queries to be executed. "A String", ], }, }, - "googleSearchCall": { # Google Search call step. + "googleSearchCall": { # Google Search content. "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. "queries": [ # Web search queries for the following-up web search. "A String", @@ -25900,31 +42011,13 @@

Method Details

"searchType": "A String", # The type of search grounding enabled. }, "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. + "urlContextCall": { # URL context content. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -25932,30 +42025,22 @@

Method Details

}, }, }, - "toolResult": { # Tool result step. + "toolResult": { # Tool result content. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. + "codeExecutionResult": { # Code execution result content. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result step. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -25967,25 +42052,87 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26013,440 +42160,741 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", + "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -26470,25 +42918,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26531,25 +42961,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26590,25 +43002,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -26628,25 +43022,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -26686,25 +43062,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26735,28 +43093,10 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -26802,25 +43142,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26854,25 +43176,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -26892,46 +43196,695 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -26955,25 +43908,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27016,25 +43951,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27075,25 +43992,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -27113,25 +44012,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -27171,25 +44052,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27223,25 +44086,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -27287,25 +44132,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27339,25 +44166,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -27377,128 +44186,563 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "contentString": "A String", # The content of the step. A single string. - }, + ], }, - ], + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -27510,113 +44754,119 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -27628,25 +44878,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27674,65 +44906,307 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -27744,25 +45218,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27790,129 +45246,305 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -27924,25 +45556,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27970,257 +45584,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -28232,225 +45752,112 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -28462,25 +45869,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28508,257 +45897,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -28770,190 +46065,460 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "widgetContextToken": "A String", }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -28965,25 +46530,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -29011,1044 +46558,493 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchCall": { # File Search content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", ], }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. + ], }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -30060,201 +47056,490 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -30266,1330 +47551,882 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCreatedEvent": { # The interaction data, used for interaction.created events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -31607,7 +48444,7 @@

Method Details

"serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. + "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -31615,22 +48452,30 @@

Method Details

}, }, }, - "toolResult": { # Tool result content. + "toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. + "codeExecutionResult": { # Code execution result step. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "fileSearchResult": { # File Search result step. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -31642,64 +48487,597 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -31714,28 +49092,28 @@

Method Details

], }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ { # The result of the Google Maps. - "places": [ # The places that were found. + "places": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "widgetContextToken": "A String", }, ], }, - "googleSearchResult": { # Google Search result content. + "googleSearchResult": { # Google Search result step. "isError": True or False, # Whether the Google Search resulted in an error. "result": [ # Required. The results of the Google Search. { # The result of the Google Search. @@ -31743,10 +49121,22 @@

Method Details

}, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -31758,25 +49148,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -31804,285 +49176,280 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -32094,25 +49461,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32140,257 +49489,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -32402,64 +49657,116 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -32484,25 +49791,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32545,25 +49834,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32604,25 +49875,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -32642,25 +49895,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -32700,25 +49935,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32752,25 +49969,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -32816,25 +50015,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32868,25 +50049,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -32908,109 +50071,94 @@

Method Details

}, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -33022,25 +50170,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33068,512 +50198,465 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "text": "A String", # Required. The text content. }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchCall": { # File Search content. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -33586,25 +50669,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33618,375 +50683,192 @@

Method Details

{ # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStartEvent": { # The interaction data, used for interaction.start events. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -34010,25 +50892,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34071,25 +50935,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34130,25 +50976,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -34168,25 +50996,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -34226,25 +51036,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34278,25 +51070,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -34307,666 +51081,570 @@

Method Details

"placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -34979,25 +51657,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -35005,949 +51665,336 @@

Method Details

"source": "A String", # Source attributed for a portion of the text. }, "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. }, - "fileSearchResult": { # File Search result step. + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, + "searchType": "A String", # The type of search grounding enabled. }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -35959,25 +52006,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -36005,380 +52034,85 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. }, }, ], @@ -36386,28 +52120,10 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. + "urlContextResult": { # URL context result content. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -36417,899 +52133,404 @@

Method Details

], }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", + }, ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. "A String", ], }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -37321,22 +52542,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -37349,25 +52566,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -37398,541 +52597,210 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStartEvent": { # The interaction data, used for interaction.start events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -37946,101 +52814,371 @@

Method Details

}, ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -38052,25 +53190,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -38098,594 +53218,290 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -38697,25 +53513,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -38743,301 +53541,256 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -39052,6 +53805,12 @@

Method Details

], }, }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). @@ -39088,25 +53847,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39149,25 +53890,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39208,25 +53931,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -39246,25 +53951,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -39304,25 +53991,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39356,25 +54025,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -39420,25 +54071,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39472,25 +54105,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -39511,6 +54126,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -39539,25 +54163,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39600,25 +54206,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39659,25 +54247,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -39697,25 +54267,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -39755,25 +54307,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39807,25 +54341,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -39871,25 +54387,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39923,25 +54421,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -39979,6 +54459,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -40017,6 +54799,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -40077,25 +55161,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40138,25 +55204,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40197,25 +55245,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -40235,25 +55265,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -40293,25 +55305,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40345,25 +55339,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -40409,25 +55385,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40461,25 +55419,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -40510,6 +55450,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -40580,25 +55822,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40641,25 +55865,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40700,25 +55906,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -40738,25 +55926,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -40796,25 +55966,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40848,25 +56000,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -40912,25 +56046,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40964,25 +56080,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -41013,6 +56111,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -41065,25 +56465,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41126,25 +56508,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41185,25 +56549,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -41223,25 +56569,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -41281,25 +56609,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41333,25 +56643,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -41397,25 +56689,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41449,25 +56723,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -41522,25 +56778,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41583,25 +56821,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41642,25 +56862,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -41680,25 +56882,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -41738,25 +56922,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41790,25 +56956,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -41854,25 +57002,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41906,25 +57036,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -41945,6 +57057,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -41973,25 +57094,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42034,25 +57137,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42093,25 +57178,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -42131,25 +57198,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -42189,25 +57238,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42241,25 +57272,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -42305,25 +57318,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42356,26 +57351,8 @@

Method Details

}, "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -42413,6 +57390,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -42451,6 +57730,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -42511,25 +58092,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42572,25 +58135,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42631,25 +58176,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -42669,25 +58196,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -42727,25 +58236,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42779,25 +58270,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -42843,25 +58316,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42895,25 +58350,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -42944,6 +58381,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -43014,25 +58753,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43075,25 +58796,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43134,25 +58837,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -43172,25 +58857,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -43230,25 +58897,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43282,25 +58931,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -43346,25 +58977,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43398,25 +59011,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -43447,6 +59042,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -43499,25 +59396,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43560,25 +59439,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43619,25 +59480,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -43657,25 +59500,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -43715,25 +59540,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43767,25 +59574,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -43831,25 +59620,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43883,25 +59654,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -43934,6 +59687,9 @@

Method Details

"codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. "environment": "A String", # The environment being operated. "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. @@ -43952,6 +59708,308 @@

Method Details

"name": "A String", # The name of the function. "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -44072,25 +60130,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44133,25 +60173,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44192,25 +60214,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -44230,25 +60234,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -44288,25 +60274,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44340,25 +60308,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -44404,25 +60354,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44456,25 +60388,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -44631,56 +60545,660 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, + "name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + ], + }, + }, + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -44692,25 +61210,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44738,257 +61238,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -45000,120 +61406,88 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "image": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - "serverToolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { - }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - }, - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -45206,25 +61580,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45267,25 +61623,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45326,25 +61664,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -45364,25 +61684,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -45422,25 +61724,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45474,25 +61758,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -45538,107 +61804,373 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", + "serverName": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -45672,25 +62204,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45745,25 +62259,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45806,25 +62302,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45865,25 +62343,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -45903,25 +62363,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -45961,25 +62403,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46013,25 +62437,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -46077,25 +62483,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46119,69 +62507,367 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "stepStart": { # The step start data, used for step.start events. + "index": 42, + "step": { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "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. }, }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "stepStart": { # The step start data, used for step.start events. - "index": 42, - "step": { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -46206,25 +62892,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46267,25 +62935,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46326,25 +62976,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -46364,25 +62996,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -46422,25 +63036,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46474,25 +63070,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -46538,25 +63116,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46590,25 +63150,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -46630,511 +63172,664 @@

Method Details

}, ], }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -47195,25 +63890,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47256,25 +63933,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47315,25 +63974,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -47353,25 +63994,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -47411,25 +64034,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47463,25 +64068,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -47527,25 +64114,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47579,55 +64148,339 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -47698,25 +64551,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47759,25 +64594,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47818,25 +64635,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -47856,25 +64655,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -47914,25 +64695,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47966,25 +64729,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -48030,25 +64775,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48082,25 +64809,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -48131,6 +64840,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -48183,25 +65194,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48244,25 +65237,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48303,25 +65278,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -48341,25 +65298,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -48399,25 +65338,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48451,25 +65372,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -48515,25 +65418,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48567,25 +65452,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -48613,6 +65480,82 @@

Method Details

}, "stepStop": { # The step stop data, used for step.stop events. "index": 42, + "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + "usage": { # Statistics on the interaction request's token usage. # Cumulative model usage stats from the start of the session. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, }, }
diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.html new file mode 100644 index 0000000000..d0fd8bc6ce --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.html @@ -0,0 +1,96 @@ + + + +

Agent Platform API . memoryBanks

+

Instance Methods

+

+ memories() +

+

Returns the memories Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html new file mode 100644 index 0000000000..4efb48c7de --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html @@ -0,0 +1,150 @@ + + + +

Agent Platform API . memoryBanks . memories

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.operations.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.operations.html new file mode 100644 index 0000000000..b0ac626cfc --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . memoryBanks . memories . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.operations.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.operations.html new file mode 100644 index 0000000000..a2437c7ee5 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . memoryBanks . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html index 14644521fc..44d8136725 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.html +++ b/docs/dyn/aiplatform_v1beta1.projects.html @@ -125,7 +125,14 @@

Method Details

An object of the form: { # This message contains configs of a publisher model. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. @@ -170,7 +177,14 @@

Method Details

{ # Request message for EndpointService.SetPublisherModelConfig. "publisherModelConfig": { # This message contains configs of a publisher model. # Required. The publisher model config. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 3522844a30..99ac8afae3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -425,7 +425,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -855,7 +856,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1310,7 +1312,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1751,7 +1754,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2200,7 +2204,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2631,7 +2636,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index cf28e69293..c6c81fd6ea 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -629,7 +629,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1246,7 +1247,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index e7fa342a54..afbe86fa85 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -759,7 +759,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1153,6 +1154,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. @@ -2482,7 +2503,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3157,6 +3179,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. @@ -3489,6 +3531,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. @@ -4042,6 +4104,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. @@ -4326,6 +4408,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. @@ -5181,7 +5283,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -5959,6 +6062,26 @@

Method Details

], "serviceAttachment": "A String", # Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. }, + "publisherModelConfig": { # This message contains configs of a publisher model. # Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, + "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, + "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. + "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` + "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. + }, + "enableOtelLogging": True or False, # This field is used for large models. If true, in addition to the original large model logs, logs will be converted in OTel schema format, and saved in otel_log column. Default value is false. + "enabled": True or False, # If logging is enabled or not. + "errorSamplingRate": 3.14, # Optional. Percentage of failed requests to be logged, expressed as a fraction in range [0,1]. Only non-transient errors will be logged (currently `500/Internal` errors). + "requestResponseLoggingSchemaVersion": "A String", # Output only. The schema version used in creating the BigQuery table for the request response logging. The versions are "v1" and "v2". The current default version is "v1". + "samplingRate": 3.14, # Percentage of requests to be logged, expressed as a fraction in range(0,1]. + }, + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "trafficSplit": { # A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index 193310fc11..67db9e20b8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -274,7 +274,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -512,7 +513,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -935,7 +937,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1173,7 +1176,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1595,7 +1599,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1833,7 +1838,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2128,6 +2134,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -2302,7 +2317,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2540,7 +2556,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2963,7 +2980,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3201,7 +3219,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3623,7 +3642,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3861,7 +3881,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4330,7 +4351,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4568,7 +4590,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4991,7 +5014,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -5229,7 +5253,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -5651,7 +5676,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -5889,7 +5915,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6184,6 +6211,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -6358,7 +6394,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6596,7 +6633,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7019,7 +7057,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7257,7 +7296,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7679,7 +7719,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7917,7 +7958,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8428,7 +8470,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8666,7 +8709,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9089,7 +9133,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9327,7 +9372,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9749,7 +9795,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9987,7 +10034,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -10282,6 +10330,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -10456,7 +10513,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -10694,7 +10752,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11117,7 +11176,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11355,7 +11415,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11777,7 +11838,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12015,7 +12077,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12497,7 +12560,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12735,7 +12799,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -13158,7 +13223,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -13396,7 +13462,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -13818,7 +13885,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -14056,7 +14124,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -14351,6 +14420,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -14525,7 +14603,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -14763,7 +14842,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15186,7 +15266,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15424,7 +15505,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15846,7 +15928,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -16084,7 +16167,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 7e10d49ef3..09b290bc2e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -315,6 +315,18 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } @@ -1549,6 +1561,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -1723,7 +1744,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1961,7 +1983,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2384,7 +2407,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2622,7 +2646,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3044,7 +3069,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3282,7 +3308,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3819,7 +3846,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4219,7 +4247,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4461,6 +4490,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -4655,6 +4688,18 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } @@ -5889,6 +5934,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -6063,7 +6117,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6301,7 +6356,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6724,7 +6780,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6962,7 +7019,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7384,7 +7442,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7622,7 +7681,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8159,7 +8219,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8559,7 +8620,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8801,6 +8863,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -9037,6 +9103,18 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } @@ -10271,6 +10349,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -10445,7 +10532,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -10683,7 +10771,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11106,7 +11195,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11344,7 +11434,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -11766,7 +11857,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12004,7 +12096,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12541,7 +12634,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -12941,7 +13035,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -13183,6 +13278,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. @@ -13390,6 +13489,18 @@

Method Details

}, "sampleCount": 42, # Optional. Number of samples for each instance in the dataset. If not specified, the default is 4. Minimum value is 1, maximum value is 32. }, + "cloudLoggingConfig": { # Specifies configuration for exporting evaluation results to Cloud Logging. # Optional. Configuration for exporting evaluation results to Cloud Logging. + "project": "A String", # Optional. Google Cloud project to write logs to. Defaults to the request project. + "resourceLabels": { # Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + "a_key": "A String", + }, + "resourceType": "A String", # Optional. MonitoredResource type. Defaults to "global" if unspecified. + "tracingContext": { # Tracing context for Observability correlation. # Optional. Tracing context for the evaluation run. + "conversationId": "A String", # Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + "spanId": "A String", # Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + "traceId": "A String", # Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + }, + }, "datasetCustomMetrics": [ # Optional. Specifications for custom dataset-level aggregations. { # Defines a custom dataset-level aggregation. "aggregationFunction": "A String", # Required. The Python code string containing the aggregation function. Expected function signature: `def aggregate(instances: list[dict[str, Any]]) -> dict[str, float]:` The `instances` argument is a list of dictionaries, where each dictionary represents a single evaluation result item. The structure of each dictionary corresponds to the fields in the `EvaluationResult` message. This includes: - `"request"`: Contains the original input data and model inputs (from `EvaluationResult.EvaluationRequest`). - `"candidate_results"`: Contains the results of any instance-level metrics (from `EvaluationResult.CandidateResults`). Example of a single item in the `instances` list: { "request": { "prompt": {"text": "What is the capital of France?"}, "golden_response": {"text": "Paris"}, "candidate_responses": [{"candidate": "model-v1", "text": "Paris"}] }, "candidate_results": [ {"metric": "exact_match", "score": 1.0}, {"metric": "bleu", "score": 0.9} ] } @@ -14624,6 +14735,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -14798,7 +14918,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15036,7 +15157,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15459,7 +15581,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -15697,7 +15820,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -16119,7 +16243,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -16357,7 +16482,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -16894,7 +17020,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -17294,7 +17421,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -17536,6 +17664,10 @@

Method Details

}, "model": "A String", # Optional. The fully qualified name of the publisher model or endpoint to use. Anthropic and Llama third-party models are also supported through Model Garden. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Third-party model formats: `projects/{project}/locations/{location}/publishers/anthropic/models/{model}` or `projects/{project}/locations/{location}/publishers/llama/models/{model}` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` "parallelism": 42, # Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. + "promptTemplate": { # Prompt template used for inference. # Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + "gcsUri": "A String", # Prompt template stored in Cloud Storage. Format: "gs://my-bucket/file-name.txt". + "promptTemplate": "A String", # Inline prompt template. Template variables should be in the format "{var_name}". Example: "Translate the following from {source_lang} to {target_lang}: {text}" + }, }, }, "labels": { # Optional. Labels for the evaluation run. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index 85dab71ea7..fce9510a75 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -264,7 +264,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -526,7 +527,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -830,7 +832,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1125,7 +1128,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1446,7 +1450,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1727,7 +1732,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1990,7 +1996,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index af03d708e4..f4f7dd9a2d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -204,6 +204,11 @@

Instance Methods

Returns the interactions Resource.

+

+ memoryBanks() +

+

Returns the memoryBanks Resource.

+

metadataStores()

@@ -588,7 +593,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -892,7 +898,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2769,7 +2776,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3096,7 +3104,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3496,7 +3505,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3734,7 +3744,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4064,7 +4075,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4302,7 +4314,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6607,7 +6620,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -6996,6 +7010,15 @@

Method Details

{ # Result for a single candidate. "additionalResults": "", # Optional. Additional results for the metric. "candidate": "A String", # Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. + "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). # Output only. Error while evaluating the candidate for the metric. + "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. + }, "explanation": "A String", # Optional. The explanation for the metric. "metric": "A String", # Required. The metric that was evaluated. "rubricVerdicts": [ # Optional. The rubric verdicts for the metric. @@ -7170,7 +7193,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7408,7 +7432,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -7831,7 +7856,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8069,7 +8095,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8491,7 +8518,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -8729,7 +8757,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9268,7 +9297,7 @@

Method Details

The object takes the form of: { # Request message for DataFoundryService.GenerateUserScenarios. - "agents": { # Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + "agents": { # Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent. "a_key": { # Represents configuration for an Agent. "agentId": "A String", # Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. "agentType": "A String", # Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. @@ -9413,7 +9442,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -9512,7 +9542,7 @@

Method Details

}, }, "allowCrossRegionModel": True or False, # Optional. Allows the scenario generation to use cross region models. When this flag is set, the service may route traffic to other regions if a model is unavailable in the current region (e.g., to a `global` endpoint). If a fully-qualified model endpoint resource name with a different region than the request location is provided elsewhere in the request, this flag must be set to true or the request will fail. - "rootAgentId": "A String", # Required. The agent id to identify the root agent. + "rootAgentId": "A String", # Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent. "userScenarioGenerationConfig": { # User scenario generation configuration. # Required. Configuration for generating user scenarios. "environmentData": "A String", # Optional. Environment data in string type. "modelName": "A String", # Optional. The model name to use for generation. It can be model name, e.g. "gemini-3-pro-preview". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}` diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 95a6db8b26..2b49a63bb6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -120,6 +120,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -159,25 +461,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -220,25 +504,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -279,25 +545,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -317,25 +565,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -375,25 +605,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -427,25 +639,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -491,25 +685,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -543,25 +719,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -607,25 +765,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -668,25 +808,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -727,25 +849,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -765,25 +869,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -823,25 +909,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -875,25 +943,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -939,25 +989,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -991,25 +1023,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -1069,6 +1083,9 @@

Method Details

}, "toolChoiceMode": "A String", # The mode of the tool choice. "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, }, "model": "A String", # The name of the `Model` used for generating the completion. }, @@ -1097,25 +1114,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1158,25 +1157,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1217,25 +1198,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -1255,25 +1218,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -1313,25 +1258,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1365,25 +1292,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -1429,25 +1338,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1481,25 +1372,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -1545,6 +1418,308 @@

Method Details

}, "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -1576,338 +1751,61 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -1920,25 +1818,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -1969,169 +1849,576 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -2155,25 +2442,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2216,25 +2485,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2275,25 +2526,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -2313,25 +2546,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -2371,25 +2586,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2423,25 +2620,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -2487,25 +2666,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2539,25 +2700,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -2577,171 +2720,517 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -2754,25 +3243,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -2803,425 +3274,16 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -3233,18 +3295,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -3257,25 +3323,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -3306,100 +3354,418 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "fileSearchCall": { # File Search content. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -3412,25 +3778,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -3461,34 +3809,280 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -3500,22 +4094,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -3528,25 +4118,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -3577,58 +4149,210 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -3642,95 +4366,355 @@

Method Details

}, ], }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -3742,25 +4726,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -3788,141 +4754,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -3934,260 +4922,147 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4199,25 +5074,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -4245,257 +5102,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -4507,293 +5270,112 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -4805,25 +5387,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -4851,257 +5415,283 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + }, }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. @@ -5127,25 +5717,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5188,25 +5760,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5247,25 +5801,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -5285,25 +5821,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -5343,25 +5861,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5395,25 +5895,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -5459,25 +5941,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5511,25 +5975,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -5551,134 +5997,171 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -5691,25 +6174,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5740,100 +6205,498 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, ], + "text": "A String", # Required. The text content. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -5846,25 +6709,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -5895,174 +6740,210 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -6076,95 +6957,44 @@

Method Details

}, ], }, + "name": "A String", # Required. The name of the tool to call. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -6176,25 +7006,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -6222,141 +7034,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -6368,376 +7202,450 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. "A String", ], }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + "fileSearchResult": { # File Search result step. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -6749,25 +7657,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -6795,141 +7685,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -6941,295 +7853,88 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - "store": True or False, # Input only. Whether to store the response and request for later retrieval. - "stream": True or False, # Input only. Whether the interaction will be streamed. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -7243,756 +7948,16996 @@

Method Details

}, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + "store": True or False, # Input only. Whether to store the response and request for later retrieval. + "stream": True or False, # Input only. Whether the interaction will be streamed. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, +} + + +
+ createStream(projectsId, locationsId, body=None, x__xgafv=None) +
Creates an interaction and streams the response.
+
+Args:
+  projectsId: string, A parameter (required)
+  locationsId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Configuration parameters for creating an interaction.
+  "background": True or False, # Input only. Whether to run the model interaction in the background.
+  "interaction": { # Response for InteractionService.CreateInteraction. # The interaction to create.
+    "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents.
+      "agent": "A String", # The name of the `Agent` used for generating the completion.
+      "deepResearchConfig": { # Configuration for the Deep Research agent.
+        "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
+        "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent.
+        "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
+        "visualization": "A String", # Whether to include visualizations in the response.
+      },
+      "dynamicConfig": { # Configuration for dynamic agents.
+        "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition.
+          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+            { # Represents a single field in a struct.
+              "name": "A String",
+              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "thought": { # A thought content block.
+                    "signature": "A String", # Signature to match the backend source to be part of the generation.
+                    "summary": [ # A summary of the thought.
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "toolCall": { # Tool call content.
+                    "codeExecutionCall": { # Code execution content.
+                      "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                        "code": "A String", # The code to be executed.
+                        "language": "A String", # Programming language of the `code`.
+                      },
+                    },
+                    "fileSearchCall": { # File Search content.
+                    },
+                    "functionCall": { # A function tool call content block.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                      "name": "A String", # Required. The name of the tool to call.
+                    },
+                    "googleMapsCall": { # Google Maps content.
+                      "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                        "queries": [ # The queries to be executed.
+                          "A String",
+                        ],
+                      },
+                    },
+                    "googleSearchCall": { # Google Search content.
+                      "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                        "queries": [ # Web search queries for the following-up web search.
+                          "A String",
+                        ],
+                      },
+                      "searchType": "A String", # The type of search grounding enabled.
+                    },
+                    "id": "A String", # Required. A unique ID for this specific tool call.
+                    "mcpServerToolCall": { # MCPServer tool call content.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                      "name": "A String", # Required. The name of the tool which was called.
+                      "serverName": "A String", # Required. The name of the used MCP server.
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextCall": { # URL context content.
+                      "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                        "urls": [ # The URLs to fetch.
+                          "A String",
+                        ],
+                      },
+                    },
+                  },
+                  "toolResult": { # Tool result content.
+                    "callId": "A String", # Required. ID to match the ID from the function call block.
+                    "codeExecutionResult": { # Code execution result content.
+                      "isError": True or False, # Whether the code execution resulted in an error.
+                      "result": "A String", # Required. The output of the code execution.
+                    },
+                    "fileSearchResult": { # File Search result content.
+                      "result": [ # Optional. The results of the File Search.
+                        { # The result of the File Search.
+                        },
+                      ],
+                    },
+                    "functionResult": { # A function tool result content block.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "isError": True or False, # Whether the tool call resulted in an error.
+                      "name": "A String", # The name of the tool that was called.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "googleMapsResult": { # Google Maps result content.
+                      "result": [ # Required. The results of the Google Maps.
+                        { # The result of the Google Maps.
+                          "places": [ # The places that were found.
+                            {
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                          ],
+                          "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                        },
+                      ],
+                    },
+                    "googleSearchResult": { # Google Search result content.
+                      "isError": True or False, # Whether the Google Search resulted in an error.
+                      "result": [ # Required. The results of the Google Search.
+                        { # The result of the Google Search.
+                          "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                        },
+                      ],
+                    },
+                    "mcpServerToolResult": { # MCPServer tool result content.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "name": "A String", # Name of the tool which is called for this specific tool call.
+                      "serverName": "A String", # The name of the used MCP server.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextResult": { # URL context result content.
+                      "isError": True or False, # Whether the URL context resulted in an error.
+                      "result": [ # Required. The results of the URL context.
+                        { # The result of the URL context.
+                          "status": "A String", # The status of the URL retrieval.
+                          "url": "A String", # The URL that was fetched.
+                        },
+                      ],
+                    },
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeType": "A String", # The mime type of the video.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiVertexV1beta1Value
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
+                "numberValue": 3.14, # Represents a double value.
+                "stringValue": "A String", # Represents a string value.
+                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+              },
+            },
+          ],
+        },
+      },
+    },
+    "content": { # The content of the response. # The content for the interaction.
+      "audio": { # An audio content block.
+        "channels": 42, # The number of audio channels.
+        "data": "A String", # The audio content.
+        "mimeType": "A String", # The mime type of the audio.
+        "sampleRate": 42, # The sample rate of the audio.
+        "uri": "A String", # The URI of the audio.
+      },
+      "document": { # A document content block.
+        "data": "A String", # The document content.
+        "mimeType": "A String", # The mime type of the document.
+        "uri": "A String", # The URI of the document.
+      },
+      "image": { # An image content block.
+        "data": "A String", # The image content.
+        "mimeType": "A String", # The mime type of the image.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the image.
+      },
+      "text": { # A text content block.
+        "annotations": [ # Citation information for model-generated content.
+          { # Citation information for model-generated content.
+            "endIndex": 42, # End of the attributed segment, exclusive.
+            "fileCitation": { # A file citation annotation. # A file citation annotation.
+              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+              "documentUri": "A String", # The URI of the file.
+              "fileName": "A String", # The name of the file.
+              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+              "pageNumber": 42, # Page number of the cited document, if applicable.
+              "source": "A String", # Source attributed for a portion of the text.
+            },
+            "placeCitation": { # A place citation annotation. # A place citation annotation.
+              "name": "A String", # Title of the place.
+              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                  "reviewId": "A String", # The ID of the review snippet.
+                  "title": "A String", # Title of the review.
+                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                },
+              ],
+              "url": "A String", # URI reference of the place.
+            },
+            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+              "title": "A String", # The title of the URL.
+              "url": "A String", # The URL.
+            },
+          },
+        ],
+        "text": "A String", # Required. The text content.
+      },
+      "thought": { # A thought content block.
+        "signature": "A String", # Signature to match the backend source to be part of the generation.
+        "summary": [ # A summary of the thought.
+          {
+            "image": { # An image content block.
+              "data": "A String", # The image content.
+              "mimeType": "A String", # The mime type of the image.
+              "resolution": "A String", # The resolution of the media.
+              "uri": "A String", # The URI of the image.
+            },
+            "text": { # A text content block.
+              "annotations": [ # Citation information for model-generated content.
+                { # Citation information for model-generated content.
+                  "endIndex": 42, # End of the attributed segment, exclusive.
+                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                    "documentUri": "A String", # The URI of the file.
+                    "fileName": "A String", # The name of the file.
+                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                    "source": "A String", # Source attributed for a portion of the text.
+                  },
+                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                    "title": "A String", # The title of the URL.
+                    "url": "A String", # The URL.
+                  },
+                },
+              ],
+              "text": "A String", # Required. The text content.
+            },
+          },
+        ],
+      },
+      "toolCall": { # Tool call content.
+        "codeExecutionCall": { # Code execution content.
+          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+            "code": "A String", # The code to be executed.
+            "language": "A String", # Programming language of the `code`.
+          },
+        },
+        "fileSearchCall": { # File Search content.
+        },
+        "functionCall": { # A function tool call content block.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+          "name": "A String", # Required. The name of the tool to call.
+        },
+        "googleMapsCall": { # Google Maps content.
+          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+            "queries": [ # The queries to be executed.
+              "A String",
+            ],
+          },
+        },
+        "googleSearchCall": { # Google Search content.
+          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+            "queries": [ # Web search queries for the following-up web search.
+              "A String",
+            ],
+          },
+          "searchType": "A String", # The type of search grounding enabled.
+        },
+        "id": "A String", # Required. A unique ID for this specific tool call.
+        "mcpServerToolCall": { # MCPServer tool call content.
+          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+          "name": "A String", # Required. The name of the tool which was called.
+          "serverName": "A String", # Required. The name of the used MCP server.
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextCall": { # URL context content.
+          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+            "urls": [ # The URLs to fetch.
+              "A String",
+            ],
+          },
+        },
+      },
+      "toolResult": { # Tool result content.
+        "callId": "A String", # Required. ID to match the ID from the function call block.
+        "codeExecutionResult": { # Code execution result content.
+          "isError": True or False, # Whether the code execution resulted in an error.
+          "result": "A String", # Required. The output of the code execution.
+        },
+        "fileSearchResult": { # File Search result content.
+          "result": [ # Optional. The results of the File Search.
+            { # The result of the File Search.
+            },
+          ],
+        },
+        "functionResult": { # A function tool result content block.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "isError": True or False, # Whether the tool call resulted in an error.
+          "name": "A String", # The name of the tool that was called.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "googleMapsResult": { # Google Maps result content.
+          "result": [ # Required. The results of the Google Maps.
+            { # The result of the Google Maps.
+              "places": [ # The places that were found.
+                {
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+              ],
+              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+            },
+          ],
+        },
+        "googleSearchResult": { # Google Search result content.
+          "isError": True or False, # Whether the Google Search resulted in an error.
+          "result": [ # Required. The results of the Google Search.
+            { # The result of the Google Search.
+              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+            },
+          ],
+        },
+        "mcpServerToolResult": { # MCPServer tool result content.
+          "contentList": {
+            "contents": [
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "name": "A String", # Name of the tool which is called for this specific tool call.
+          "serverName": "A String", # The name of the used MCP server.
+          "stringResult": "A String",
+          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+        },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": { # URL context result content.
+          "isError": True or False, # Whether the URL context resulted in an error.
+          "result": [ # Required. The results of the URL context.
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
+            },
+          ],
+        },
+      },
+      "video": { # A video content block.
+        "data": "A String", # The video content.
+        "mimeType": "A String", # The mime type of the video.
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String", # The URI of the video.
+      },
+    },
+    "contentList": { # A list of Content. # The inputs for the interaction.
+      "contents": [ # The contents of the list.
+        { # The content of the response.
+          "audio": { # An audio content block.
+            "channels": 42, # The number of audio channels.
+            "data": "A String", # The audio content.
+            "mimeType": "A String", # The mime type of the audio.
+            "sampleRate": 42, # The sample rate of the audio.
+            "uri": "A String", # The URI of the audio.
+          },
+          "document": { # A document content block.
+            "data": "A String", # The document content.
+            "mimeType": "A String", # The mime type of the document.
+            "uri": "A String", # The URI of the document.
+          },
+          "image": { # An image content block.
+            "data": "A String", # The image content.
+            "mimeType": "A String", # The mime type of the image.
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String", # The URI of the image.
+          },
+          "text": { # A text content block.
+            "annotations": [ # Citation information for model-generated content.
+              { # Citation information for model-generated content.
+                "endIndex": 42, # End of the attributed segment, exclusive.
+                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                  "documentUri": "A String", # The URI of the file.
+                  "fileName": "A String", # The name of the file.
+                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                  "source": "A String", # Source attributed for a portion of the text.
+                },
+                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                  "title": "A String", # The title of the URL.
+                  "url": "A String", # The URL.
+                },
+              },
+            ],
+            "text": "A String", # Required. The text content.
+          },
+          "thought": { # A thought content block.
+            "signature": "A String", # Signature to match the backend source to be part of the generation.
+            "summary": [ # A summary of the thought.
+              {
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+              },
+            ],
+          },
+          "toolCall": { # Tool call content.
+            "codeExecutionCall": { # Code execution content.
+              "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                "code": "A String", # The code to be executed.
+                "language": "A String", # Programming language of the `code`.
+              },
+            },
+            "fileSearchCall": { # File Search content.
+            },
+            "functionCall": { # A function tool call content block.
+              "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+              "name": "A String", # Required. The name of the tool to call.
+            },
+            "googleMapsCall": { # Google Maps content.
+              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                "queries": [ # The queries to be executed.
+                  "A String",
+                ],
+              },
+            },
+            "googleSearchCall": { # Google Search content.
+              "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                "queries": [ # Web search queries for the following-up web search.
+                  "A String",
+                ],
+              },
+              "searchType": "A String", # The type of search grounding enabled.
+            },
+            "id": "A String", # Required. A unique ID for this specific tool call.
+            "mcpServerToolCall": { # MCPServer tool call content.
+              "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+              "name": "A String", # Required. The name of the tool which was called.
+              "serverName": "A String", # Required. The name of the used MCP server.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextCall": { # URL context content.
+              "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                "urls": [ # The URLs to fetch.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "toolResult": { # Tool result content.
+            "callId": "A String", # Required. ID to match the ID from the function call block.
+            "codeExecutionResult": { # Code execution result content.
+              "isError": True or False, # Whether the code execution resulted in an error.
+              "result": "A String", # Required. The output of the code execution.
+            },
+            "fileSearchResult": { # File Search result content.
+              "result": [ # Optional. The results of the File Search.
+                { # The result of the File Search.
+                },
+              ],
+            },
+            "functionResult": { # A function tool result content block.
+              "contentList": {
+                "contents": [
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "isError": True or False, # Whether the tool call resulted in an error.
+              "name": "A String", # The name of the tool that was called.
+              "stringResult": "A String",
+              "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+            },
+            "googleMapsResult": { # Google Maps result content.
+              "result": [ # Required. The results of the Google Maps.
+                { # The result of the Google Maps.
+                  "places": [ # The places that were found.
+                    {
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                  ],
+                  "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                },
+              ],
+            },
+            "googleSearchResult": { # Google Search result content.
+              "isError": True or False, # Whether the Google Search resulted in an error.
+              "result": [ # Required. The results of the Google Search.
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                },
+              ],
+            },
+            "mcpServerToolResult": { # MCPServer tool result content.
+              "contentList": {
+                "contents": [
+                  {
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Name of the tool which is called for this specific tool call.
+              "serverName": "A String", # The name of the used MCP server.
+              "stringResult": "A String",
+              "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextResult": { # URL context result content.
+              "isError": True or False, # Whether the URL context resulted in an error.
+              "result": [ # Required. The results of the URL context.
+                { # The result of the URL context.
+                  "status": "A String", # The status of the URL retrieval.
+                  "url": "A String", # The URL that was fetched.
+                },
+              ],
+            },
+          },
+          "video": { # A video content block.
+            "data": "A String", # The video content.
+            "mimeType": "A String", # The mime type of the video.
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String", # The URI of the video.
+          },
+        },
+      ],
+    },
+    "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).
+    "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment.
+    "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request.
+    "id": "A String", # Required. Output only. A unique identifier for the interaction completion.
+    "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models.
+      "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
+      "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction.
+        "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0].
+        "imageConfig": { # The configuration for image interaction. # Configuration for image interaction.
+          "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.
+          "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.
+        },
+        "maxOutputTokens": 42, # The maximum number of tokens to include in the response.
+        "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0].
+        "seed": 42, # Seed used in decoding for reproducibility.
+        "speechConfig": [ # Configuration for speech interaction.
+          { # The configuration for speech interaction.
+            "language": "A String", # The language of the speech.
+            "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt.
+            "voice": "A String", # The voice of the speaker.
+          },
+        ],
+        "stopSequences": [ # A list of character sequences that will stop output interaction.
+          "A String",
+        ],
+        "temperature": 3.14, # Controls the randomness of the output.
+        "thinkingLevel": "A String", # The level of thought tokens that the model should generate.
+        "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
+        "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice.
+          "allowedTools": { # The configuration for allowed tools. # The allowed tools.
+            "mode": "A String", # The mode of the tool choice.
+            "tools": [ # The names of the allowed tools.
+              "A String",
+            ],
+          },
+        },
+        "toolChoiceMode": "A String", # The mode of the tool choice.
+        "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling.
+        "videoConfig": { # Configuration options for video generation. # Configuration for video generation.
+          "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media.
+        },
+      },
+      "model": "A String", # The name of the `Model` used for generating the completion.
+    },
+    "outputs": [ # Output only. Responses from the model.
+      { # The content of the response.
+        "audio": { # An audio content block.
+          "channels": 42, # The number of audio channels.
+          "data": "A String", # The audio content.
+          "mimeType": "A String", # The mime type of the audio.
+          "sampleRate": 42, # The sample rate of the audio.
+          "uri": "A String", # The URI of the audio.
+        },
+        "document": { # A document content block.
+          "data": "A String", # The document content.
+          "mimeType": "A String", # The mime type of the document.
+          "uri": "A String", # The URI of the document.
+        },
+        "image": { # An image content block.
+          "data": "A String", # The image content.
+          "mimeType": "A String", # The mime type of the image.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the image.
+        },
+        "text": { # A text content block.
+          "annotations": [ # Citation information for model-generated content.
+            { # Citation information for model-generated content.
+              "endIndex": 42, # End of the attributed segment, exclusive.
+              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                "documentUri": "A String", # The URI of the file.
+                "fileName": "A String", # The name of the file.
+                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                "pageNumber": 42, # Page number of the cited document, if applicable.
+                "source": "A String", # Source attributed for a portion of the text.
+              },
+              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                "name": "A String", # Title of the place.
+                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                    "reviewId": "A String", # The ID of the review snippet.
+                    "title": "A String", # Title of the review.
+                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                  },
+                ],
+                "url": "A String", # URI reference of the place.
+              },
+              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                "title": "A String", # The title of the URL.
+                "url": "A String", # The URL.
+              },
+            },
+          ],
+          "text": "A String", # Required. The text content.
+        },
+        "thought": { # A thought content block.
+          "signature": "A String", # Signature to match the backend source to be part of the generation.
+          "summary": [ # A summary of the thought.
+            {
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+            },
+          ],
+        },
+        "toolCall": { # Tool call content.
+          "codeExecutionCall": { # Code execution content.
+            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+              "code": "A String", # The code to be executed.
+              "language": "A String", # Programming language of the `code`.
+            },
+          },
+          "fileSearchCall": { # File Search content.
+          },
+          "functionCall": { # A function tool call content block.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+            "name": "A String", # Required. The name of the tool to call.
+          },
+          "googleMapsCall": { # Google Maps content.
+            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+              "queries": [ # The queries to be executed.
+                "A String",
+              ],
+            },
+          },
+          "googleSearchCall": { # Google Search content.
+            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+              "queries": [ # Web search queries for the following-up web search.
+                "A String",
+              ],
+            },
+            "searchType": "A String", # The type of search grounding enabled.
+          },
+          "id": "A String", # Required. A unique ID for this specific tool call.
+          "mcpServerToolCall": { # MCPServer tool call content.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+            "name": "A String", # Required. The name of the tool which was called.
+            "serverName": "A String", # Required. The name of the used MCP server.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextCall": { # URL context content.
+            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+              "urls": [ # The URLs to fetch.
+                "A String",
+              ],
+            },
+          },
+        },
+        "toolResult": { # Tool result content.
+          "callId": "A String", # Required. ID to match the ID from the function call block.
+          "codeExecutionResult": { # Code execution result content.
+            "isError": True or False, # Whether the code execution resulted in an error.
+            "result": "A String", # Required. The output of the code execution.
+          },
+          "fileSearchResult": { # File Search result content.
+            "result": [ # Optional. The results of the File Search.
+              { # The result of the File Search.
+              },
+            ],
+          },
+          "functionResult": { # A function tool result content block.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "isError": True or False, # Whether the tool call resulted in an error.
+            "name": "A String", # The name of the tool that was called.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "googleMapsResult": { # Google Maps result content.
+            "result": [ # Required. The results of the Google Maps.
+              { # The result of the Google Maps.
+                "places": [ # The places that were found.
+                  {
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                ],
+                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+              },
+            ],
+          },
+          "googleSearchResult": { # Google Search result content.
+            "isError": True or False, # Whether the Google Search resulted in an error.
+            "result": [ # Required. The results of the Google Search.
+              { # The result of the Google Search.
+                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+              },
+            ],
+          },
+          "mcpServerToolResult": { # MCPServer tool result content.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Name of the tool which is called for this specific tool call.
+            "serverName": "A String", # The name of the used MCP server.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextResult": { # URL context result content.
+            "isError": True or False, # Whether the URL context resulted in an error.
+            "result": [ # Required. The results of the URL context.
+              { # The result of the URL context.
+                "status": "A String", # The status of the URL retrieval.
+                "url": "A String", # The URL that was fetched.
+              },
+            ],
+          },
+        },
+        "video": { # A video content block.
+          "data": "A String", # The video content.
+          "mimeType": "A String", # The mime type of the video.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the video.
+        },
+      },
+    ],
+    "previousInteractionId": "A String", # The ID of the previous interaction, if any.
+    "remoteEnvironment": { # Configuration for a custom environment.
+      "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains.
+        "allowlist": [ # List of allowed domains and their configurations.
+          { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request.
+            "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains.
+            "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token").
+              "a_key": "A String",
+            },
+          },
+        ],
+      },
+      "networkMode": "A String", # Network egress mode.
+      "sources": [
+        { # A source to be mounted into the environment.
+          "content": "A String", # The inline content if `type` is `INLINE`.
+          "encoding": "A String", # Optional encoding for inline content (e.g. `base64`).
+          "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.
+          "target": "A String", # Where the source should appear in the environment.
+          "type": "A String",
+        },
+      ],
+    },
+    "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
+      "boolValue": True or False, # Represents a boolean value.
+      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+        "audio": { # An audio content block.
+          "channels": 42, # The number of audio channels.
+          "data": "A String", # The audio content.
+          "mimeType": "A String", # The mime type of the audio.
+          "sampleRate": 42, # The sample rate of the audio.
+          "uri": "A String", # The URI of the audio.
+        },
+        "document": { # A document content block.
+          "data": "A String", # The document content.
+          "mimeType": "A String", # The mime type of the document.
+          "uri": "A String", # The URI of the document.
+        },
+        "image": { # An image content block.
+          "data": "A String", # The image content.
+          "mimeType": "A String", # The mime type of the image.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the image.
+        },
+        "text": { # A text content block.
+          "annotations": [ # Citation information for model-generated content.
+            { # Citation information for model-generated content.
+              "endIndex": 42, # End of the attributed segment, exclusive.
+              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                "documentUri": "A String", # The URI of the file.
+                "fileName": "A String", # The name of the file.
+                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                "pageNumber": 42, # Page number of the cited document, if applicable.
+                "source": "A String", # Source attributed for a portion of the text.
+              },
+              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                "name": "A String", # Title of the place.
+                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                    "reviewId": "A String", # The ID of the review snippet.
+                    "title": "A String", # Title of the review.
+                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                  },
+                ],
+                "url": "A String", # URI reference of the place.
+              },
+              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                "title": "A String", # The title of the URL.
+                "url": "A String", # The URL.
+              },
+            },
+          ],
+          "text": "A String", # Required. The text content.
+        },
+        "thought": { # A thought content block.
+          "signature": "A String", # Signature to match the backend source to be part of the generation.
+          "summary": [ # A summary of the thought.
+            {
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeType": "A String", # The mime type of the image.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+            },
+          ],
+        },
+        "toolCall": { # Tool call content.
+          "codeExecutionCall": { # Code execution content.
+            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+              "code": "A String", # The code to be executed.
+              "language": "A String", # Programming language of the `code`.
+            },
+          },
+          "fileSearchCall": { # File Search content.
+          },
+          "functionCall": { # A function tool call content block.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+            "name": "A String", # Required. The name of the tool to call.
+          },
+          "googleMapsCall": { # Google Maps content.
+            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+              "queries": [ # The queries to be executed.
+                "A String",
+              ],
+            },
+          },
+          "googleSearchCall": { # Google Search content.
+            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+              "queries": [ # Web search queries for the following-up web search.
+                "A String",
+              ],
+            },
+            "searchType": "A String", # The type of search grounding enabled.
+          },
+          "id": "A String", # Required. A unique ID for this specific tool call.
+          "mcpServerToolCall": { # MCPServer tool call content.
+            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+            "name": "A String", # Required. The name of the tool which was called.
+            "serverName": "A String", # Required. The name of the used MCP server.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextCall": { # URL context content.
+            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+              "urls": [ # The URLs to fetch.
+                "A String",
+              ],
+            },
+          },
+        },
+        "toolResult": { # Tool result content.
+          "callId": "A String", # Required. ID to match the ID from the function call block.
+          "codeExecutionResult": { # Code execution result content.
+            "isError": True or False, # Whether the code execution resulted in an error.
+            "result": "A String", # Required. The output of the code execution.
+          },
+          "fileSearchResult": { # File Search result content.
+            "result": [ # Optional. The results of the File Search.
+              { # The result of the File Search.
+              },
+            ],
+          },
+          "functionResult": { # A function tool result content block.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "isError": True or False, # Whether the tool call resulted in an error.
+            "name": "A String", # The name of the tool that was called.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "googleMapsResult": { # Google Maps result content.
+            "result": [ # Required. The results of the Google Maps.
+              { # The result of the Google Maps.
+                "places": [ # The places that were found.
+                  {
+                    "name": "A String", # Title of the place.
+                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String", # URI reference of the place.
+                  },
+                ],
+                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+              },
+            ],
+          },
+          "googleSearchResult": { # Google Search result content.
+            "isError": True or False, # Whether the Google Search resulted in an error.
+            "result": [ # Required. The results of the Google Search.
+              { # The result of the Google Search.
+                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+              },
+            ],
+          },
+          "mcpServerToolResult": { # MCPServer tool result content.
+            "contentList": {
+              "contents": [
+                {
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Name of the tool which is called for this specific tool call.
+            "serverName": "A String", # The name of the used MCP server.
+            "stringResult": "A String",
+            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextResult": { # URL context result content.
+            "isError": True or False, # Whether the URL context resulted in an error.
+            "result": [ # Required. The results of the URL context.
+              { # The result of the URL context.
+                "status": "A String", # The status of the URL retrieval.
+                "url": "A String", # The URL that was fetched.
+              },
+            ],
+          },
+        },
+        "video": { # A video content block.
+          "data": "A String", # The video content.
+          "mimeType": "A String", # The mime type of the video.
+          "resolution": "A String", # The resolution of the media.
+          "uri": "A String", # The URI of the video.
+        },
+      },
+      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+        "values": [ # Repeated field of dynamically typed values.
+          # Object with schema name: GenaiVertexV1beta1Value
+        ],
+      },
+      "nullValue": "A String", # Represents a null value.
+      "numberValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+    },
+    "responseFormatList": {
+      "responseFormats": [
+        {
+          "audio": { # Configuration for audio output format.
+            "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+            "delivery": "A String", # The delivery mode for the audio output.
+            "mimeType": "A String", # The MIME type of the audio output.
+            "sampleRate": 42, # Sample rate in Hz.
+          },
+          "image": { # Configuration for image output format.
+            "aspectRatio": "A String", # The aspect ratio for the image output.
+            "delivery": "A String", # The delivery mode for the image output.
+            "imageSize": "A String", # The size of the image output.
+            "mimeType": "A String", # The MIME type of the image output.
+          },
+          "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS
+            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+              { # Represents a single field in a struct.
+                "name": "A String",
+                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                  "boolValue": True or False, # Represents a boolean value.
+                  "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                    "values": [ # Repeated field of dynamically typed values.
+                      # Object with schema name: GenaiVertexV1beta1Value
+                    ],
+                  },
+                  "nullValue": "A String", # Represents a null value.
+                  "numberValue": 3.14, # Represents a double value.
+                  "stringValue": "A String", # Represents a string value.
+                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                },
+              },
+            ],
+          },
+          "text": { # Configuration for text output format.
+            "mimeType": "A String", # The MIME type of the text output.
+            "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeType": "A String", # The mime type of the audio.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeType": "A String", # The mime type of the document.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "thought": { # A thought content block.
+                        "signature": "A String", # Signature to match the backend source to be part of the generation.
+                        "summary": [ # A summary of the thought.
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "toolCall": { # Tool call content.
+                        "codeExecutionCall": { # Code execution content.
+                          "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                            "code": "A String", # The code to be executed.
+                            "language": "A String", # Programming language of the `code`.
+                          },
+                        },
+                        "fileSearchCall": { # File Search content.
+                        },
+                        "functionCall": { # A function tool call content block.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                          "name": "A String", # Required. The name of the tool to call.
+                        },
+                        "googleMapsCall": { # Google Maps content.
+                          "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                            "queries": [ # The queries to be executed.
+                              "A String",
+                            ],
+                          },
+                        },
+                        "googleSearchCall": { # Google Search content.
+                          "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                            "queries": [ # Web search queries for the following-up web search.
+                              "A String",
+                            ],
+                          },
+                          "searchType": "A String", # The type of search grounding enabled.
+                        },
+                        "id": "A String", # Required. A unique ID for this specific tool call.
+                        "mcpServerToolCall": { # MCPServer tool call content.
+                          "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                          "name": "A String", # Required. The name of the tool which was called.
+                          "serverName": "A String", # Required. The name of the used MCP server.
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextCall": { # URL context content.
+                          "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                            "urls": [ # The URLs to fetch.
+                              "A String",
+                            ],
+                          },
+                        },
+                      },
+                      "toolResult": { # Tool result content.
+                        "callId": "A String", # Required. ID to match the ID from the function call block.
+                        "codeExecutionResult": { # Code execution result content.
+                          "isError": True or False, # Whether the code execution resulted in an error.
+                          "result": "A String", # Required. The output of the code execution.
+                        },
+                        "fileSearchResult": { # File Search result content.
+                          "result": [ # Optional. The results of the File Search.
+                            { # The result of the File Search.
+                            },
+                          ],
+                        },
+                        "functionResult": { # A function tool result content block.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "isError": True or False, # Whether the tool call resulted in an error.
+                          "name": "A String", # The name of the tool that was called.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "googleMapsResult": { # Google Maps result content.
+                          "result": [ # Required. The results of the Google Maps.
+                            { # The result of the Google Maps.
+                              "places": [ # The places that were found.
+                                {
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                              ],
+                              "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                            },
+                          ],
+                        },
+                        "googleSearchResult": { # Google Search result content.
+                          "isError": True or False, # Whether the Google Search resulted in an error.
+                          "result": [ # Required. The results of the Google Search.
+                            { # The result of the Google Search.
+                              "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                            },
+                          ],
+                        },
+                        "mcpServerToolResult": { # MCPServer tool result content.
+                          "contentList": {
+                            "contents": [
+                              {
+                                "image": { # An image content block.
+                                  "data": "A String", # The image content.
+                                  "mimeType": "A String", # The mime type of the image.
+                                  "resolution": "A String", # The resolution of the media.
+                                  "uri": "A String", # The URI of the image.
+                                },
+                                "text": { # A text content block.
+                                  "annotations": [ # Citation information for model-generated content.
+                                    { # Citation information for model-generated content.
+                                      "endIndex": 42, # End of the attributed segment, exclusive.
+                                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                        "documentUri": "A String", # The URI of the file.
+                                        "fileName": "A String", # The name of the file.
+                                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                                        "source": "A String", # Source attributed for a portion of the text.
+                                      },
+                                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                        "name": "A String", # Title of the place.
+                                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                            "reviewId": "A String", # The ID of the review snippet.
+                                            "title": "A String", # Title of the review.
+                                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                          },
+                                        ],
+                                        "url": "A String", # URI reference of the place.
+                                      },
+                                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                        "title": "A String", # The title of the URL.
+                                        "url": "A String", # The URL.
+                                      },
+                                    },
+                                  ],
+                                  "text": "A String", # Required. The text content.
+                                },
+                              },
+                            ],
+                          },
+                          "name": "A String", # Name of the tool which is called for this specific tool call.
+                          "serverName": "A String", # The name of the used MCP server.
+                          "stringResult": "A String",
+                          "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                        },
+                        "signature": "A String", # A signature hash for backend validation.
+                        "urlContextResult": { # URL context result content.
+                          "isError": True or False, # Whether the URL context resulted in an error.
+                          "result": [ # Required. The results of the URL context.
+                            { # The result of the URL context.
+                              "status": "A String", # The status of the URL retrieval.
+                              "url": "A String", # The URL that was fetched.
+                            },
+                          ],
+                        },
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeType": "A String", # The mime type of the video.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiVertexV1beta1Value
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+          },
+          "video": { # Configuration for video output format.
+            "aspectRatio": "A String", # The aspect ratio for the video output.
+            "delivery": "A String", # The delivery mode for the video output.
+            "duration": "A String", # The duration for the video output.
+            "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI.
+          },
+        },
+      ],
+    },
+    "responseFormatSingleton": {
+      "audio": { # Configuration for audio output format.
+        "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).
+        "delivery": "A String", # The delivery mode for the audio output.
+        "mimeType": "A String", # The MIME type of the audio output.
+        "sampleRate": 42, # Sample rate in Hz.
+      },
+      "image": { # Configuration for image output format.
+        "aspectRatio": "A String", # The aspect ratio for the image output.
+        "delivery": "A String", # The delivery mode for the image output.
+        "imageSize": "A String", # The size of the image output.
+        "mimeType": "A String", # The MIME type of the image output.
+      },
+      "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS
+        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+          { # Represents a single field in a struct.
+            "name": "A String",
+            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiVertexV1beta1Value
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+            },
+          },
+        ],
+      },
+      "text": { # Configuration for text output format.
+        "mimeType": "A String", # The MIME type of the text output.
+        "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json.
+          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+            { # Represents a single field in a struct.
+              "name": "A String",
+              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeType": "A String", # The mime type of the image.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "thought": { # A thought content block.
+                    "signature": "A String", # Signature to match the backend source to be part of the generation.
+                    "summary": [ # A summary of the thought.
+                      {
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                      },
+                    ],
+                  },
+                  "toolCall": { # Tool call content.
+                    "codeExecutionCall": { # Code execution content.
+                      "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                        "code": "A String", # The code to be executed.
+                        "language": "A String", # Programming language of the `code`.
+                      },
+                    },
+                    "fileSearchCall": { # File Search content.
+                    },
+                    "functionCall": { # A function tool call content block.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                      "name": "A String", # Required. The name of the tool to call.
+                    },
+                    "googleMapsCall": { # Google Maps content.
+                      "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                        "queries": [ # The queries to be executed.
+                          "A String",
+                        ],
+                      },
+                    },
+                    "googleSearchCall": { # Google Search content.
+                      "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                        "queries": [ # Web search queries for the following-up web search.
+                          "A String",
+                        ],
+                      },
+                      "searchType": "A String", # The type of search grounding enabled.
+                    },
+                    "id": "A String", # Required. A unique ID for this specific tool call.
+                    "mcpServerToolCall": { # MCPServer tool call content.
+                      "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                      "name": "A String", # Required. The name of the tool which was called.
+                      "serverName": "A String", # Required. The name of the used MCP server.
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextCall": { # URL context content.
+                      "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                        "urls": [ # The URLs to fetch.
+                          "A String",
+                        ],
+                      },
+                    },
+                  },
+                  "toolResult": { # Tool result content.
+                    "callId": "A String", # Required. ID to match the ID from the function call block.
+                    "codeExecutionResult": { # Code execution result content.
+                      "isError": True or False, # Whether the code execution resulted in an error.
+                      "result": "A String", # Required. The output of the code execution.
+                    },
+                    "fileSearchResult": { # File Search result content.
+                      "result": [ # Optional. The results of the File Search.
+                        { # The result of the File Search.
+                        },
+                      ],
+                    },
+                    "functionResult": { # A function tool result content block.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "isError": True or False, # Whether the tool call resulted in an error.
+                      "name": "A String", # The name of the tool that was called.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "googleMapsResult": { # Google Maps result content.
+                      "result": [ # Required. The results of the Google Maps.
+                        { # The result of the Google Maps.
+                          "places": [ # The places that were found.
+                            {
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                          ],
+                          "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                        },
+                      ],
+                    },
+                    "googleSearchResult": { # Google Search result content.
+                      "isError": True or False, # Whether the Google Search resulted in an error.
+                      "result": [ # Required. The results of the Google Search.
+                        { # The result of the Google Search.
+                          "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                        },
+                      ],
+                    },
+                    "mcpServerToolResult": { # MCPServer tool result content.
+                      "contentList": {
+                        "contents": [
+                          {
+                            "image": { # An image content block.
+                              "data": "A String", # The image content.
+                              "mimeType": "A String", # The mime type of the image.
+                              "resolution": "A String", # The resolution of the media.
+                              "uri": "A String", # The URI of the image.
+                            },
+                            "text": { # A text content block.
+                              "annotations": [ # Citation information for model-generated content.
+                                { # Citation information for model-generated content.
+                                  "endIndex": 42, # End of the attributed segment, exclusive.
+                                  "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                    "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                    "documentUri": "A String", # The URI of the file.
+                                    "fileName": "A String", # The name of the file.
+                                    "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                    "pageNumber": 42, # Page number of the cited document, if applicable.
+                                    "source": "A String", # Source attributed for a portion of the text.
+                                  },
+                                  "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                  "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                  "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                    "title": "A String", # The title of the URL.
+                                    "url": "A String", # The URL.
+                                  },
+                                },
+                              ],
+                              "text": "A String", # Required. The text content.
+                            },
+                          },
+                        ],
+                      },
+                      "name": "A String", # Name of the tool which is called for this specific tool call.
+                      "serverName": "A String", # The name of the used MCP server.
+                      "stringResult": "A String",
+                      "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                    },
+                    "signature": "A String", # A signature hash for backend validation.
+                    "urlContextResult": { # URL context result content.
+                      "isError": True or False, # Whether the URL context resulted in an error.
+                      "result": [ # Required. The results of the URL context.
+                        { # The result of the URL context.
+                          "status": "A String", # The status of the URL retrieval.
+                          "url": "A String", # The URL that was fetched.
+                        },
+                      ],
+                    },
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeType": "A String", # The mime type of the video.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiVertexV1beta1Value
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
                 "numberValue": 3.14, # Represents a double value.
                 "stringValue": "A String", # Represents a string value.
                 "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
               },
             },
-          ],
-        },
-        "name": "A String", # Required. The name of the tool to call.
-      },
-      "googleMapsCall": { # Google Maps content.
-        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
-          "queries": [ # The queries to be executed.
-            "A String",
-          ],
-        },
-      },
-      "googleSearchCall": { # Google Search content.
-        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
-          "queries": [ # Web search queries for the following-up web search.
-            "A String",
-          ],
-        },
-        "searchType": "A String", # The type of search grounding enabled.
-      },
-      "id": "A String", # Required. A unique ID for this specific tool call.
-      "mcpServerToolCall": { # MCPServer tool call content.
-        "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
-                  ],
-                },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+          ],
+        },
+      },
+      "video": { # Configuration for video output format.
+        "aspectRatio": "A String", # The aspect ratio for the video output.
+        "delivery": "A String", # The delivery mode for the video output.
+        "duration": "A String", # The duration for the video output.
+        "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI.
+      },
+    },
+    "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set.
+    "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO).
+      "A String",
+    ],
+    "role": "A String", # Output only. The role of the interaction.
+    "status": "A String", # Required. Output only. The status of the interaction.
+    "stepList": { # A list of Steps. # Input only. The steps for the interaction.
+      "steps": [ # The steps of the list.
+        { # A step in the interaction.
+          "modelOutput": { # Output generated by the model.
+            "content": [
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+            "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.
+            },
+          },
+          "thought": { # A thought step.
+            "signature": "A String", # A signature hash for backend validation.
+            "summary": [ # A summary of the thought.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeType": "A String", # The mime type of the audio.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeType": "A String", # The mime type of the document.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeType": "A String", # The mime type of the image.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "thought": { # A thought content block.
+                  "signature": "A String", # Signature to match the backend source to be part of the generation.
+                  "summary": [ # A summary of the thought.
+                    {
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeType": "A String", # The mime type of the image.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                    },
+                  ],
+                },
+                "toolCall": { # Tool call content.
+                  "codeExecutionCall": { # Code execution content.
+                    "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                      "code": "A String", # The code to be executed.
+                      "language": "A String", # Programming language of the `code`.
+                    },
+                  },
+                  "fileSearchCall": { # File Search content.
+                  },
+                  "functionCall": { # A function tool call content block.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                    "name": "A String", # Required. The name of the tool to call.
+                  },
+                  "googleMapsCall": { # Google Maps content.
+                    "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                      "queries": [ # The queries to be executed.
+                        "A String",
+                      ],
+                    },
+                  },
+                  "googleSearchCall": { # Google Search content.
+                    "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                      "queries": [ # Web search queries for the following-up web search.
+                        "A String",
+                      ],
+                    },
+                    "searchType": "A String", # The type of search grounding enabled.
+                  },
+                  "id": "A String", # Required. A unique ID for this specific tool call.
+                  "mcpServerToolCall": { # MCPServer tool call content.
+                    "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                    "name": "A String", # Required. The name of the tool which was called.
+                    "serverName": "A String", # Required. The name of the used MCP server.
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextCall": { # URL context content.
+                    "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                      "urls": [ # The URLs to fetch.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "toolResult": { # Tool result content.
+                  "callId": "A String", # Required. ID to match the ID from the function call block.
+                  "codeExecutionResult": { # Code execution result content.
+                    "isError": True or False, # Whether the code execution resulted in an error.
+                    "result": "A String", # Required. The output of the code execution.
+                  },
+                  "fileSearchResult": { # File Search result content.
+                    "result": [ # Optional. The results of the File Search.
+                      { # The result of the File Search.
+                      },
+                    ],
+                  },
+                  "functionResult": { # A function tool result content block.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "isError": True or False, # Whether the tool call resulted in an error.
+                    "name": "A String", # The name of the tool that was called.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "googleMapsResult": { # Google Maps result content.
+                    "result": [ # Required. The results of the Google Maps.
+                      { # The result of the Google Maps.
+                        "places": [ # The places that were found.
+                          {
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                        ],
+                        "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                      },
+                    ],
+                  },
+                  "googleSearchResult": { # Google Search result content.
+                    "isError": True or False, # Whether the Google Search resulted in an error.
+                    "result": [ # Required. The results of the Google Search.
+                      { # The result of the Google Search.
+                        "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                      },
+                    ],
+                  },
+                  "mcpServerToolResult": { # MCPServer tool result content.
+                    "contentList": {
+                      "contents": [
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "name": "A String", # Name of the tool which is called for this specific tool call.
+                    "serverName": "A String", # The name of the used MCP server.
+                    "stringResult": "A String",
+                    "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                  },
+                  "signature": "A String", # A signature hash for backend validation.
+                  "urlContextResult": { # URL context result content.
+                    "isError": True or False, # Whether the URL context resulted in an error.
+                    "result": [ # Required. The results of the URL context.
+                      { # The result of the URL context.
+                        "status": "A String", # The status of the URL retrieval.
+                        "url": "A String", # The URL that was fetched.
+                      },
+                    ],
+                  },
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeType": "A String", # The mime type of the video.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "toolCall": { # Tool call step.
+            "codeExecutionCall": { # Code execution call step.
+              "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                "code": "A String", # The code to be executed.
+                "language": "A String", # Programming language of the `code`.
+              },
+            },
+            "fileSearchCall": { # File Search call step.
+            },
+            "functionCall": { # A function tool call step.
+              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeType": "A String", # The mime type of the audio.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeType": "A String", # The mime type of the document.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "thought": { # A thought content block.
+                          "signature": "A String", # Signature to match the backend source to be part of the generation.
+                          "summary": [ # A summary of the thought.
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "toolCall": { # Tool call content.
+                          "codeExecutionCall": { # Code execution content.
+                            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                              "code": "A String", # The code to be executed.
+                              "language": "A String", # Programming language of the `code`.
+                            },
+                          },
+                          "fileSearchCall": { # File Search content.
+                          },
+                          "functionCall": { # A function tool call content block.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                            "name": "A String", # Required. The name of the tool to call.
+                          },
+                          "googleMapsCall": { # Google Maps content.
+                            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                              "queries": [ # The queries to be executed.
+                                "A String",
+                              ],
+                            },
+                          },
+                          "googleSearchCall": { # Google Search content.
+                            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                              "queries": [ # Web search queries for the following-up web search.
+                                "A String",
+                              ],
+                            },
+                            "searchType": "A String", # The type of search grounding enabled.
+                          },
+                          "id": "A String", # Required. A unique ID for this specific tool call.
+                          "mcpServerToolCall": { # MCPServer tool call content.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                            "name": "A String", # Required. The name of the tool which was called.
+                            "serverName": "A String", # Required. The name of the used MCP server.
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextCall": { # URL context content.
+                            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                              "urls": [ # The URLs to fetch.
+                                "A String",
+                              ],
+                            },
+                          },
+                        },
+                        "toolResult": { # Tool result content.
+                          "callId": "A String", # Required. ID to match the ID from the function call block.
+                          "codeExecutionResult": { # Code execution result content.
+                            "isError": True or False, # Whether the code execution resulted in an error.
+                            "result": "A String", # Required. The output of the code execution.
+                          },
+                          "fileSearchResult": { # File Search result content.
+                            "result": [ # Optional. The results of the File Search.
+                              { # The result of the File Search.
+                              },
+                            ],
+                          },
+                          "functionResult": { # A function tool result content block.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
+                            },
+                            "isError": True or False, # Whether the tool call resulted in an error.
+                            "name": "A String", # The name of the tool that was called.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "googleMapsResult": { # Google Maps result content.
+                            "result": [ # Required. The results of the Google Maps.
+                              { # The result of the Google Maps.
+                                "places": [ # The places that were found.
+                                  {
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                ],
+                                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                              },
+                            ],
+                          },
+                          "googleSearchResult": { # Google Search result content.
+                            "isError": True or False, # Whether the Google Search resulted in an error.
+                            "result": [ # Required. The results of the Google Search.
+                              { # The result of the Google Search.
+                                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                              },
+                            ],
+                          },
+                          "mcpServerToolResult": { # MCPServer tool result content.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
+                            },
+                            "name": "A String", # Name of the tool which is called for this specific tool call.
+                            "serverName": "A String", # The name of the used MCP server.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextResult": { # URL context result content.
+                            "isError": True or False, # Whether the URL context resulted in an error.
+                            "result": [ # Required. The results of the URL context.
+                              { # The result of the URL context.
+                                "status": "A String", # The status of the URL retrieval.
+                                "url": "A String", # The URL that was fetched.
+                              },
+                            ],
+                          },
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeType": "A String", # The mime type of the video.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiVertexV1beta1Value
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Required. The name of the tool to call.
+            },
+            "googleMapsCall": { # Google Maps call step.
+              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                "queries": [ # The queries to be executed.
+                  "A String",
+                ],
+              },
+            },
+            "googleSearchCall": { # Google Search call step.
+              "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                "queries": [ # Web search queries for the following-up web search.
+                  "A String",
+                ],
+              },
+              "searchType": "A String", # The type of search grounding enabled.
+            },
+            "id": "A String", # Required. A unique ID for this specific tool call.
+            "mcpServerToolCall": { # MCPServer tool call step.
+              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeType": "A String", # The mime type of the audio.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeType": "A String", # The mime type of the document.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "thought": { # A thought content block.
+                          "signature": "A String", # Signature to match the backend source to be part of the generation.
+                          "summary": [ # A summary of the thought.
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "toolCall": { # Tool call content.
+                          "codeExecutionCall": { # Code execution content.
+                            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                              "code": "A String", # The code to be executed.
+                              "language": "A String", # Programming language of the `code`.
+                            },
+                          },
+                          "fileSearchCall": { # File Search content.
+                          },
+                          "functionCall": { # A function tool call content block.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                            "name": "A String", # Required. The name of the tool to call.
+                          },
+                          "googleMapsCall": { # Google Maps content.
+                            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                              "queries": [ # The queries to be executed.
+                                "A String",
+                              ],
+                            },
+                          },
+                          "googleSearchCall": { # Google Search content.
+                            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                              "queries": [ # Web search queries for the following-up web search.
+                                "A String",
+                              ],
+                            },
+                            "searchType": "A String", # The type of search grounding enabled.
+                          },
+                          "id": "A String", # Required. A unique ID for this specific tool call.
+                          "mcpServerToolCall": { # MCPServer tool call content.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                            "name": "A String", # Required. The name of the tool which was called.
+                            "serverName": "A String", # Required. The name of the used MCP server.
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextCall": { # URL context content.
+                            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                              "urls": [ # The URLs to fetch.
+                                "A String",
+                              ],
+                            },
+                          },
+                        },
+                        "toolResult": { # Tool result content.
+                          "callId": "A String", # Required. ID to match the ID from the function call block.
+                          "codeExecutionResult": { # Code execution result content.
+                            "isError": True or False, # Whether the code execution resulted in an error.
+                            "result": "A String", # Required. The output of the code execution.
+                          },
+                          "fileSearchResult": { # File Search result content.
+                            "result": [ # Optional. The results of the File Search.
+                              { # The result of the File Search.
+                              },
+                            ],
+                          },
+                          "functionResult": { # A function tool result content block.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
+                            },
+                            "isError": True or False, # Whether the tool call resulted in an error.
+                            "name": "A String", # The name of the tool that was called.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "googleMapsResult": { # Google Maps result content.
+                            "result": [ # Required. The results of the Google Maps.
+                              { # The result of the Google Maps.
+                                "places": [ # The places that were found.
+                                  {
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                ],
+                                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                              },
+                            ],
+                          },
+                          "googleSearchResult": { # Google Search result content.
+                            "isError": True or False, # Whether the Google Search resulted in an error.
+                            "result": [ # Required. The results of the Google Search.
+                              { # The result of the Google Search.
+                                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                              },
+                            ],
+                          },
+                          "mcpServerToolResult": { # MCPServer tool result content.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
+                            },
+                            "name": "A String", # Name of the tool which is called for this specific tool call.
+                            "serverName": "A String", # The name of the used MCP server.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextResult": { # URL context result content.
+                            "isError": True or False, # Whether the URL context resulted in an error.
+                            "result": [ # Required. The results of the URL context.
+                              { # The result of the URL context.
+                                "status": "A String", # The status of the URL retrieval.
+                                "url": "A String", # The URL that was fetched.
+                              },
+                            ],
+                          },
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeType": "A String", # The mime type of the video.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiVertexV1beta1Value
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Required. The name of the tool which was called.
+              "serverName": "A String", # Required. The name of the used MCP server.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextCall": { # URL context call step.
+              "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                "urls": [ # The URLs to fetch.
+                  "A String",
+                ],
               },
             },
-          ],
-        },
-        "name": "A String", # Required. The name of the tool which was called.
-        "serverName": "A String", # Required. The name of the used MCP server.
-      },
-      "signature": "A String", # A signature hash for backend validation.
-      "urlContextCall": { # URL context content.
-        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
-          "urls": [ # The URLs to fetch.
-            "A String",
-          ],
-        },
-      },
-    },
-    "toolResult": { # Tool result content.
-      "callId": "A String", # Required. ID to match the ID from the function call block.
-      "codeExecutionResult": { # Code execution result content.
-        "isError": True or False, # Whether the code execution resulted in an error.
-        "result": "A String", # Required. The output of the code execution.
-      },
-      "fileSearchResult": { # File Search result content.
-        "result": [ # Optional. The results of the File Search.
-          { # The result of the File Search.
           },
-        ],
-      },
-      "functionResult": { # A function tool result content block.
-        "contentList": {
-          "contents": [
-            {
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeType": "A String", # The mime type of the image.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
+          "toolResult": { # Tool result step.
+            "callId": "A String", # Required. ID to match the ID from the function call block.
+            "codeExecutionResult": { # Code execution result step.
+              "isError": True or False, # Whether the code execution resulted in an error.
+              "result": "A String", # Required. The output of the code execution.
+            },
+            "fileSearchResult": { # File Search result step.
+            },
+            "functionResult": { # Result of a function tool call.
+              "contentList": { # A list of Content.
+                "contents": [ # The contents of the list.
+                  { # The content of the response.
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
+                          },
+                        ],
+                      },
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                ],
               },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                          { # Represents a single field in a struct.
-                            "name": "A String",
-                            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                              "boolValue": True or False, # Represents a boolean value.
-                              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                "values": [ # Repeated field of dynamically typed values.
-                                  # Object with schema name: GenaiVertexV1beta1Value
+              "isError": True or False, # Whether the tool call resulted in an error.
+              "name": "A String", # The name of the tool that was called.
+              "stringResult": "A String",
+              "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeType": "A String", # The mime type of the audio.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeType": "A String", # The mime type of the document.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "thought": { # A thought content block.
+                          "signature": "A String", # Signature to match the backend source to be part of the generation.
+                          "summary": [ # A summary of the thought.
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "toolCall": { # Tool call content.
+                          "codeExecutionCall": { # Code execution content.
+                            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                              "code": "A String", # The code to be executed.
+                              "language": "A String", # Programming language of the `code`.
+                            },
+                          },
+                          "fileSearchCall": { # File Search content.
+                          },
+                          "functionCall": { # A function tool call content block.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                            "name": "A String", # Required. The name of the tool to call.
+                          },
+                          "googleMapsCall": { # Google Maps content.
+                            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                              "queries": [ # The queries to be executed.
+                                "A String",
+                              ],
+                            },
+                          },
+                          "googleSearchCall": { # Google Search content.
+                            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                              "queries": [ # Web search queries for the following-up web search.
+                                "A String",
+                              ],
+                            },
+                            "searchType": "A String", # The type of search grounding enabled.
+                          },
+                          "id": "A String", # Required. A unique ID for this specific tool call.
+                          "mcpServerToolCall": { # MCPServer tool call content.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                            "name": "A String", # Required. The name of the tool which was called.
+                            "serverName": "A String", # Required. The name of the used MCP server.
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextCall": { # URL context content.
+                            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                              "urls": [ # The URLs to fetch.
+                                "A String",
+                              ],
+                            },
+                          },
+                        },
+                        "toolResult": { # Tool result content.
+                          "callId": "A String", # Required. ID to match the ID from the function call block.
+                          "codeExecutionResult": { # Code execution result content.
+                            "isError": True or False, # Whether the code execution resulted in an error.
+                            "result": "A String", # Required. The output of the code execution.
+                          },
+                          "fileSearchResult": { # File Search result content.
+                            "result": [ # Optional. The results of the File Search.
+                              { # The result of the File Search.
+                              },
+                            ],
+                          },
+                          "functionResult": { # A function tool result content block.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
+                            },
+                            "isError": True or False, # Whether the tool call resulted in an error.
+                            "name": "A String", # The name of the tool that was called.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "googleMapsResult": { # Google Maps result content.
+                            "result": [ # Required. The results of the Google Maps.
+                              { # The result of the Google Maps.
+                                "places": [ # The places that were found.
+                                  {
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
                                 ],
+                                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
                               },
-                              "nullValue": "A String", # Represents a null value.
-                              "numberValue": 3.14, # Represents a double value.
-                              "stringValue": "A String", # Represents a string value.
-                              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                            ],
+                          },
+                          "googleSearchResult": { # Google Search result content.
+                            "isError": True or False, # Whether the Google Search resulted in an error.
+                            "result": [ # Required. The results of the Google Search.
+                              { # The result of the Google Search.
+                                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                              },
+                            ],
+                          },
+                          "mcpServerToolResult": { # MCPServer tool result content.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
                             },
+                            "name": "A String", # Name of the tool which is called for this specific tool call.
+                            "serverName": "A String", # The name of the used MCP server.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextResult": { # URL context result content.
+                            "isError": True or False, # Whether the URL context resulted in an error.
+                            "result": [ # Required. The results of the URL context.
+                              { # The result of the URL context.
+                                "status": "A String", # The status of the URL retrieval.
+                                "url": "A String", # The URL that was fetched.
+                              },
+                            ],
                           },
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeType": "A String", # The mime type of the video.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiVertexV1beta1Value
                         ],
                       },
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                     },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                  },
+                ],
+              },
+            },
+            "googleMapsResult": { # Google Maps result step.
+              "result": [
+                { # The result of the Google Maps.
+                  "places": [
+                    {
+                      "name": "A String",
+                      "placeId": "A String",
+                      "reviewSnippets": [
                         { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
                           "reviewId": "A String", # The ID of the review snippet.
                           "title": "A String", # Title of the review.
                           "url": "A String", # A link that corresponds to the user review on Google Maps.
                         },
                       ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
+                      "url": "A String",
                     },
-                  },
-                ],
-                "text": "A String", # Required. The text content.
-              },
-            },
-          ],
-        },
-        "isError": True or False, # Whether the tool call resulted in an error.
-        "name": "A String", # The name of the tool that was called.
-        "stringResult": "A String",
-        "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
                   ],
+                  "widgetContextToken": "A String",
                 },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-              },
+              ],
             },
-          ],
-        },
-      },
-      "googleMapsResult": { # Google Maps result content.
-        "result": [ # Required. The results of the Google Maps.
-          { # The result of the Google Maps.
-            "places": [ # The places that were found.
-              {
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-            ],
-            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
-          },
-        ],
-      },
-      "googleSearchResult": { # Google Search result content.
-        "isError": True or False, # Whether the Google Search resulted in an error.
-        "result": [ # Required. The results of the Google Search.
-          { # The result of the Google Search.
-            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
-          },
-        ],
-      },
-      "mcpServerToolResult": { # MCPServer tool result content.
-        "contentList": {
-          "contents": [
-            {
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeType": "A String", # The mime type of the image.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                          { # Represents a single field in a struct.
-                            "name": "A String",
-                            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                              "boolValue": True or False, # Represents a boolean value.
-                              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                "values": [ # Repeated field of dynamically typed values.
-                                  # Object with schema name: GenaiVertexV1beta1Value
+            "googleSearchResult": { # Google Search result step.
+              "isError": True or False, # Whether the Google Search resulted in an error.
+              "result": [ # Required. The results of the Google Search.
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                },
+              ],
+            },
+            "mcpServerToolResult": { # MCPServer tool result step.
+              "contentList": { # A list of Content.
+                "contents": [ # The contents of the list.
+                  { # The content of the response.
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeType": "A String", # The mime type of the audio.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeType": "A String", # The mime type of the document.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeType": "A String", # The mime type of the image.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "thought": { # A thought content block.
+                      "signature": "A String", # Signature to match the backend source to be part of the generation.
+                      "summary": [ # A summary of the thought.
+                        {
+                          "image": { # An image content block.
+                            "data": "A String", # The image content.
+                            "mimeType": "A String", # The mime type of the image.
+                            "resolution": "A String", # The resolution of the media.
+                            "uri": "A String", # The URI of the image.
+                          },
+                          "text": { # A text content block.
+                            "annotations": [ # Citation information for model-generated content.
+                              { # Citation information for model-generated content.
+                                "endIndex": 42, # End of the attributed segment, exclusive.
+                                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                  "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                  "documentUri": "A String", # The URI of the file.
+                                  "fileName": "A String", # The name of the file.
+                                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                                  "source": "A String", # Source attributed for a portion of the text.
+                                },
+                                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                  "name": "A String", # Title of the place.
+                                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                      "reviewId": "A String", # The ID of the review snippet.
+                                      "title": "A String", # Title of the review.
+                                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                    },
+                                  ],
+                                  "url": "A String", # URI reference of the place.
+                                },
+                                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                  "title": "A String", # The title of the URL.
+                                  "url": "A String", # The URL.
+                                },
+                              },
+                            ],
+                            "text": "A String", # Required. The text content.
+                          },
+                        },
+                      ],
+                    },
+                    "toolCall": { # Tool call content.
+                      "codeExecutionCall": { # Code execution content.
+                        "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                          "code": "A String", # The code to be executed.
+                          "language": "A String", # Programming language of the `code`.
+                        },
+                      },
+                      "fileSearchCall": { # File Search content.
+                      },
+                      "functionCall": { # A function tool call content block.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                        "name": "A String", # Required. The name of the tool to call.
+                      },
+                      "googleMapsCall": { # Google Maps content.
+                        "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                          "queries": [ # The queries to be executed.
+                            "A String",
+                          ],
+                        },
+                      },
+                      "googleSearchCall": { # Google Search content.
+                        "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                          "queries": [ # Web search queries for the following-up web search.
+                            "A String",
+                          ],
+                        },
+                        "searchType": "A String", # The type of search grounding enabled.
+                      },
+                      "id": "A String", # Required. A unique ID for this specific tool call.
+                      "mcpServerToolCall": { # MCPServer tool call content.
+                        "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                        "name": "A String", # Required. The name of the tool which was called.
+                        "serverName": "A String", # Required. The name of the used MCP server.
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextCall": { # URL context content.
+                        "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                          "urls": [ # The URLs to fetch.
+                            "A String",
+                          ],
+                        },
+                      },
+                    },
+                    "toolResult": { # Tool result content.
+                      "callId": "A String", # Required. ID to match the ID from the function call block.
+                      "codeExecutionResult": { # Code execution result content.
+                        "isError": True or False, # Whether the code execution resulted in an error.
+                        "result": "A String", # Required. The output of the code execution.
+                      },
+                      "fileSearchResult": { # File Search result content.
+                        "result": [ # Optional. The results of the File Search.
+                          { # The result of the File Search.
+                          },
+                        ],
+                      },
+                      "functionResult": { # A function tool result content block.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
+                                ],
+                                "text": "A String", # Required. The text content.
+                              },
+                            },
+                          ],
+                        },
+                        "isError": True or False, # Whether the tool call resulted in an error.
+                        "name": "A String", # The name of the tool that was called.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "googleMapsResult": { # Google Maps result content.
+                        "result": [ # Required. The results of the Google Maps.
+                          { # The result of the Google Maps.
+                            "places": [ # The places that were found.
+                              {
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                            ],
+                            "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                          },
+                        ],
+                      },
+                      "googleSearchResult": { # Google Search result content.
+                        "isError": True or False, # Whether the Google Search resulted in an error.
+                        "result": [ # Required. The results of the Google Search.
+                          { # The result of the Google Search.
+                            "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                          },
+                        ],
+                      },
+                      "mcpServerToolResult": { # MCPServer tool result content.
+                        "contentList": {
+                          "contents": [
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
                                 ],
+                                "text": "A String", # Required. The text content.
                               },
-                              "nullValue": "A String", # Represents a null value.
-                              "numberValue": 3.14, # Represents a double value.
-                              "stringValue": "A String", # Represents a string value.
-                              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                             },
+                          ],
+                        },
+                        "name": "A String", # Name of the tool which is called for this specific tool call.
+                        "serverName": "A String", # The name of the used MCP server.
+                        "stringResult": "A String",
+                        "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                      },
+                      "signature": "A String", # A signature hash for backend validation.
+                      "urlContextResult": { # URL context result content.
+                        "isError": True or False, # Whether the URL context resulted in an error.
+                        "result": [ # Required. The results of the URL context.
+                          { # The result of the URL context.
+                            "status": "A String", # The status of the URL retrieval.
+                            "url": "A String", # The URL that was fetched.
                           },
                         ],
                       },
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
                     },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
-                        },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeType": "A String", # The mime type of the video.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
                     },
                   },
                 ],
-                "text": "A String", # Required. The text content.
-              },
-            },
-          ],
-        },
-        "name": "A String", # Name of the tool which is called for this specific tool call.
-        "serverName": "A String", # The name of the used MCP server.
-        "stringResult": "A String",
-        "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
-                  ],
-                },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
               },
-            },
-          ],
-        },
-      },
-      "signature": "A String", # A signature hash for backend validation.
-      "urlContextResult": { # URL context result content.
-        "isError": True or False, # Whether the URL context resulted in an error.
-        "result": [ # Required. The results of the URL context.
-          { # The result of the URL context.
-            "status": "A String", # The status of the URL retrieval.
-            "url": "A String", # The URL that was fetched.
-          },
-        ],
-      },
-    },
-    "video": { # A video content block.
-      "data": "A String", # The video content.
-      "mimeType": "A String", # The mime type of the video.
-      "resolution": "A String", # The resolution of the media.
-      "uri": "A String", # The URI of the video.
-    },
-  },
-  "contentList": { # A list of Content. # The inputs for the interaction.
-    "contents": [ # The contents of the list.
-      { # The content of the response.
-        "audio": { # An audio content block.
-          "channels": 42, # The number of audio channels.
-          "data": "A String", # The audio content.
-          "mimeType": "A String", # The mime type of the audio.
-          "sampleRate": 42, # The sample rate of the audio.
-          "uri": "A String", # The URI of the audio.
-        },
-        "document": { # A document content block.
-          "data": "A String", # The document content.
-          "mimeType": "A String", # The mime type of the document.
-          "uri": "A String", # The URI of the document.
-        },
-        "image": { # An image content block.
-          "data": "A String", # The image content.
-          "mimeType": "A String", # The mime type of the image.
-          "resolution": "A String", # The resolution of the media.
-          "uri": "A String", # The URI of the image.
-        },
-        "text": { # A text content block.
-          "annotations": [ # Citation information for model-generated content.
-            { # Citation information for model-generated content.
-              "endIndex": 42, # End of the attributed segment, exclusive.
-              "fileCitation": { # A file citation annotation. # A file citation annotation.
-                "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                  "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                    { # Represents a single field in a struct.
-                      "name": "A String",
-                      "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                        "boolValue": True or False, # Represents a boolean value.
-                        "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                          "values": [ # Repeated field of dynamically typed values.
-                            # Object with schema name: GenaiVertexV1beta1Value
+              "name": "A String", # Name of the tool which is called for this specific tool call.
+              "serverName": "A String", # The name of the used MCP server.
+              "stringResult": "A String",
+              "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeType": "A String", # The mime type of the audio.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeType": "A String", # The mime type of the document.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeType": "A String", # The mime type of the image.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                            },
                           ],
+                          "text": "A String", # Required. The text content.
                         },
-                        "nullValue": "A String", # Represents a null value.
-                        "numberValue": 3.14, # Represents a double value.
-                        "stringValue": "A String", # Represents a string value.
-                        "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                      },
-                    },
-                  ],
-                },
-                "documentUri": "A String", # The URI of the file.
-                "fileName": "A String", # The name of the file.
-                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                "pageNumber": 42, # Page number of the cited document, if applicable.
-                "source": "A String", # Source attributed for a portion of the text.
-              },
-              "placeCitation": { # A place citation annotation. # A place citation annotation.
-                "name": "A String", # Title of the place.
-                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                    "reviewId": "A String", # The ID of the review snippet.
-                    "title": "A String", # Title of the review.
-                    "url": "A String", # A link that corresponds to the user review on Google Maps.
-                  },
-                ],
-                "url": "A String", # URI reference of the place.
-              },
-              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-              "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                "title": "A String", # The title of the URL.
-                "url": "A String", # The URL.
-              },
-            },
-          ],
-          "text": "A String", # Required. The text content.
-        },
-        "thought": { # A thought content block.
-          "signature": "A String", # Signature to match the backend source to be part of the generation.
-          "summary": [ # A summary of the thought.
-            {
-              "image": { # An image content block.
-                "data": "A String", # The image content.
-                "mimeType": "A String", # The mime type of the image.
-                "resolution": "A String", # The resolution of the media.
-                "uri": "A String", # The URI of the image.
-              },
-              "text": { # A text content block.
-                "annotations": [ # Citation information for model-generated content.
-                  { # Citation information for model-generated content.
-                    "endIndex": 42, # End of the attributed segment, exclusive.
-                    "fileCitation": { # A file citation annotation. # A file citation annotation.
-                      "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                        "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                          { # Represents a single field in a struct.
-                            "name": "A String",
-                            "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                              "boolValue": True or False, # Represents a boolean value.
-                              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                "values": [ # Repeated field of dynamically typed values.
-                                  # Object with schema name: GenaiVertexV1beta1Value
+                        "thought": { # A thought content block.
+                          "signature": "A String", # Signature to match the backend source to be part of the generation.
+                          "summary": [ # A summary of the thought.
+                            {
+                              "image": { # An image content block.
+                                "data": "A String", # The image content.
+                                "mimeType": "A String", # The mime type of the image.
+                                "resolution": "A String", # The resolution of the media.
+                                "uri": "A String", # The URI of the image.
+                              },
+                              "text": { # A text content block.
+                                "annotations": [ # Citation information for model-generated content.
+                                  { # Citation information for model-generated content.
+                                    "endIndex": 42, # End of the attributed segment, exclusive.
+                                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                      "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                      "documentUri": "A String", # The URI of the file.
+                                      "fileName": "A String", # The name of the file.
+                                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                                      "source": "A String", # Source attributed for a portion of the text.
+                                    },
+                                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                      "name": "A String", # Title of the place.
+                                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                          "reviewId": "A String", # The ID of the review snippet.
+                                          "title": "A String", # Title of the review.
+                                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                        },
+                                      ],
+                                      "url": "A String", # URI reference of the place.
+                                    },
+                                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                      "title": "A String", # The title of the URL.
+                                      "url": "A String", # The URL.
+                                    },
+                                  },
                                 ],
+                                "text": "A String", # Required. The text content.
                               },
-                              "nullValue": "A String", # Represents a null value.
-                              "numberValue": 3.14, # Represents a double value.
-                              "stringValue": "A String", # Represents a string value.
-                              "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
+                            },
+                          ],
+                        },
+                        "toolCall": { # Tool call content.
+                          "codeExecutionCall": { # Code execution content.
+                            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                              "code": "A String", # The code to be executed.
+                              "language": "A String", # Programming language of the `code`.
+                            },
+                          },
+                          "fileSearchCall": { # File Search content.
+                          },
+                          "functionCall": { # A function tool call content block.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function.
+                            "name": "A String", # Required. The name of the tool to call.
+                          },
+                          "googleMapsCall": { # Google Maps content.
+                            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                              "queries": [ # The queries to be executed.
+                                "A String",
+                              ],
+                            },
+                          },
+                          "googleSearchCall": { # Google Search content.
+                            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                              "queries": [ # Web search queries for the following-up web search.
+                                "A String",
+                              ],
+                            },
+                            "searchType": "A String", # The type of search grounding enabled.
+                          },
+                          "id": "A String", # Required. A unique ID for this specific tool call.
+                          "mcpServerToolCall": { # MCPServer tool call content.
+                            "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function.
+                            "name": "A String", # Required. The name of the tool which was called.
+                            "serverName": "A String", # Required. The name of the used MCP server.
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextCall": { # URL context content.
+                            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                              "urls": [ # The URLs to fetch.
+                                "A String",
+                              ],
                             },
                           },
-                        ],
-                      },
-                      "documentUri": "A String", # The URI of the file.
-                      "fileName": "A String", # The name of the file.
-                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                      "pageNumber": 42, # Page number of the cited document, if applicable.
-                      "source": "A String", # Source attributed for a portion of the text.
-                    },
-                    "placeCitation": { # A place citation annotation. # A place citation annotation.
-                      "name": "A String", # Title of the place.
-                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                          "reviewId": "A String", # The ID of the review snippet.
-                          "title": "A String", # Title of the review.
-                          "url": "A String", # A link that corresponds to the user review on Google Maps.
                         },
-                      ],
-                      "url": "A String", # URI reference of the place.
-                    },
-                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                    "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                      "title": "A String", # The title of the URL.
-                      "url": "A String", # The URL.
-                    },
-                  },
-                ],
-                "text": "A String", # Required. The text content.
-              },
-            },
-          ],
-        },
-        "toolCall": { # Tool call content.
-          "codeExecutionCall": { # Code execution content.
-            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
-              "code": "A String", # The code to be executed.
-              "language": "A String", # Programming language of the `code`.
-            },
-          },
-          "fileSearchCall": { # File Search content.
-          },
-          "functionCall": { # A function tool call content block.
-            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
-              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                { # Represents a single field in a struct.
-                  "name": "A String",
-                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                    "boolValue": True or False, # Represents a boolean value.
-                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                      "values": [ # Repeated field of dynamically typed values.
-                        # Object with schema name: GenaiVertexV1beta1Value
-                      ],
-                    },
-                    "nullValue": "A String", # Represents a null value.
-                    "numberValue": 3.14, # Represents a double value.
-                    "stringValue": "A String", # Represents a string value.
-                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                  },
-                },
-              ],
-            },
-            "name": "A String", # Required. The name of the tool to call.
-          },
-          "googleMapsCall": { # Google Maps content.
-            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
-              "queries": [ # The queries to be executed.
-                "A String",
-              ],
-            },
-          },
-          "googleSearchCall": { # Google Search content.
-            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
-              "queries": [ # Web search queries for the following-up web search.
-                "A String",
-              ],
-            },
-            "searchType": "A String", # The type of search grounding enabled.
-          },
-          "id": "A String", # Required. A unique ID for this specific tool call.
-          "mcpServerToolCall": { # MCPServer tool call content.
-            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
-              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                { # Represents a single field in a struct.
-                  "name": "A String",
-                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                    "boolValue": True or False, # Represents a boolean value.
-                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                      "values": [ # Repeated field of dynamically typed values.
-                        # Object with schema name: GenaiVertexV1beta1Value
-                      ],
-                    },
-                    "nullValue": "A String", # Represents a null value.
-                    "numberValue": 3.14, # Represents a double value.
-                    "stringValue": "A String", # Represents a string value.
-                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-                  },
-                },
-              ],
-            },
-            "name": "A String", # Required. The name of the tool which was called.
-            "serverName": "A String", # Required. The name of the used MCP server.
-          },
-          "signature": "A String", # A signature hash for backend validation.
-          "urlContextCall": { # URL context content.
-            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
-              "urls": [ # The URLs to fetch.
-                "A String",
-              ],
-            },
-          },
-        },
-        "toolResult": { # Tool result content.
-          "callId": "A String", # Required. ID to match the ID from the function call block.
-          "codeExecutionResult": { # Code execution result content.
-            "isError": True or False, # Whether the code execution resulted in an error.
-            "result": "A String", # Required. The output of the code execution.
-          },
-          "fileSearchResult": { # File Search result content.
-            "result": [ # Optional. The results of the File Search.
-              { # The result of the File Search.
-              },
-            ],
-          },
-          "functionResult": { # A function tool result content block.
-            "contentList": {
-              "contents": [
-                {
-                  "image": { # An image content block.
-                    "data": "A String", # The image content.
-                    "mimeType": "A String", # The mime type of the image.
-                    "resolution": "A String", # The resolution of the media.
-                    "uri": "A String", # The URI of the image.
-                  },
-                  "text": { # A text content block.
-                    "annotations": [ # Citation information for model-generated content.
-                      { # Citation information for model-generated content.
-                        "endIndex": 42, # End of the attributed segment, exclusive.
-                        "fileCitation": { # A file citation annotation. # A file citation annotation.
-                          "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context.
-                            "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                              { # Represents a single field in a struct.
-                                "name": "A String",
-                                "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                                  "boolValue": True or False, # Represents a boolean value.
-                                  "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                                    "values": [ # Repeated field of dynamically typed values.
-                                      # Object with schema name: GenaiVertexV1beta1Value
+                        "toolResult": { # Tool result content.
+                          "callId": "A String", # Required. ID to match the ID from the function call block.
+                          "codeExecutionResult": { # Code execution result content.
+                            "isError": True or False, # Whether the code execution resulted in an error.
+                            "result": "A String", # Required. The output of the code execution.
+                          },
+                          "fileSearchResult": { # File Search result content.
+                            "result": [ # Optional. The results of the File Search.
+                              { # The result of the File Search.
+                              },
+                            ],
+                          },
+                          "functionResult": { # A function tool result content block.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
                                     ],
+                                    "text": "A String", # Required. The text content.
                                   },
-                                  "nullValue": "A String", # Represents a null value.
-                                  "numberValue": 3.14, # Represents a double value.
-                                  "stringValue": "A String", # Represents a string value.
-                                  "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                                 },
+                              ],
+                            },
+                            "isError": True or False, # Whether the tool call resulted in an error.
+                            "name": "A String", # The name of the tool that was called.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "googleMapsResult": { # Google Maps result content.
+                            "result": [ # Required. The results of the Google Maps.
+                              { # The result of the Google Maps.
+                                "places": [ # The places that were found.
+                                  {
+                                    "name": "A String", # Title of the place.
+                                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                        "reviewId": "A String", # The ID of the review snippet.
+                                        "title": "A String", # Title of the review.
+                                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                      },
+                                    ],
+                                    "url": "A String", # URI reference of the place.
+                                  },
+                                ],
+                                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
                               },
                             ],
                           },
-                          "documentUri": "A String", # The URI of the file.
-                          "fileName": "A String", # The name of the file.
-                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
-                          "pageNumber": 42, # Page number of the cited document, if applicable.
-                          "source": "A String", # Source attributed for a portion of the text.
-                        },
-                        "placeCitation": { # A place citation annotation. # A place citation annotation.
-                          "name": "A String", # Title of the place.
-                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                              "reviewId": "A String", # The ID of the review snippet.
-                              "title": "A String", # Title of the review.
-                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          "googleSearchResult": { # Google Search result content.
+                            "isError": True or False, # Whether the Google Search resulted in an error.
+                            "result": [ # Required. The results of the Google Search.
+                              { # The result of the Google Search.
+                                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                              },
+                            ],
+                          },
+                          "mcpServerToolResult": { # MCPServer tool result content.
+                            "contentList": {
+                              "contents": [
+                                {
+                                  "image": { # An image content block.
+                                    "data": "A String", # The image content.
+                                    "mimeType": "A String", # The mime type of the image.
+                                    "resolution": "A String", # The resolution of the media.
+                                    "uri": "A String", # The URI of the image.
+                                  },
+                                  "text": { # A text content block.
+                                    "annotations": [ # Citation information for model-generated content.
+                                      { # Citation information for model-generated content.
+                                        "endIndex": 42, # End of the attributed segment, exclusive.
+                                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                          "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context.
+                                          "documentUri": "A String", # The URI of the file.
+                                          "fileName": "A String", # The name of the file.
+                                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                                          "source": "A String", # Source attributed for a portion of the text.
+                                        },
+                                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                          "name": "A String", # Title of the place.
+                                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                              "reviewId": "A String", # The ID of the review snippet.
+                                              "title": "A String", # Title of the review.
+                                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                            },
+                                          ],
+                                          "url": "A String", # URI reference of the place.
+                                        },
+                                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
+                                          "title": "A String", # The title of the URL.
+                                          "url": "A String", # The URL.
+                                        },
+                                      },
+                                    ],
+                                    "text": "A String", # Required. The text content.
+                                  },
+                                },
+                              ],
                             },
-                          ],
-                          "url": "A String", # URI reference of the place.
+                            "name": "A String", # Name of the tool which is called for this specific tool call.
+                            "serverName": "A String", # The name of the used MCP server.
+                            "stringResult": "A String",
+                            "structResult": # Object with schema name: GenaiVertexV1beta1Struct
+                          },
+                          "signature": "A String", # A signature hash for backend validation.
+                          "urlContextResult": { # URL context result content.
+                            "isError": True or False, # Whether the URL context resulted in an error.
+                            "result": [ # Required. The results of the URL context.
+                              { # The result of the URL context.
+                                "status": "A String", # The status of the URL retrieval.
+                                "url": "A String", # The URL that was fetched.
+                              },
+                            ],
+                          },
                         },
-                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
-                        "urlCitation": { # A URL citation annotation. # A URL citation annotation.
-                          "title": "A String", # The title of the URL.
-                          "url": "A String", # The URL.
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeType": "A String", # The mime type of the video.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
                         },
                       },
-                    ],
-                    "text": "A String", # Required. The text content.
-                  },
-                },
-              ],
-            },
-            "isError": True or False, # Whether the tool call resulted in an error.
-            "name": "A String", # The name of the tool that was called.
-            "stringResult": "A String",
-            "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
-              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-                { # Represents a single field in a struct.
-                  "name": "A String",
-                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                    "boolValue": True or False, # Represents a boolean value.
-                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                      "values": [ # Repeated field of dynamically typed values.
-                        # Object with schema name: GenaiVertexV1beta1Value
-                      ],
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiVertexV1beta1Value
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                     },
-                    "nullValue": "A String", # Represents a null value.
-                    "numberValue": 3.14, # Represents a double value.
-                    "stringValue": "A String", # Represents a string value.
-                    "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
                   },
+                ],
+              },
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextResult": { # URL context result step.
+              "isError": True or False, # Whether the URL context resulted in an error.
+              "result": [ # Required. The results of the URL context.
+                { # The result of the URL context.
+                  "status": "A String", # The status of the URL retrieval.
+                  "url": "A String", # The URL that was fetched.
                 },
               ],
             },
           },
-          "googleMapsResult": { # Google Maps result content.
-            "result": [ # Required. The results of the Google Maps.
-              { # The result of the Google Maps.
-                "places": [ # The places that were found.
-                  {
-                    "name": "A String", # Title of the place.
-                    "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
-                    "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
-                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
-                        "reviewId": "A String", # The ID of the review snippet.
-                        "title": "A String", # Title of the review.
-                        "url": "A String", # A link that corresponds to the user review on Google Maps.
-                      },
-                    ],
-                    "url": "A String", # URI reference of the place.
+          "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only
+            "contentList": { # A list of Content. # The content of the step. An array of Content objects.
+              "contents": [ # The contents of the list.
+                { # The content of the response.
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeType": "A String", # The mime type of the audio.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeType": "A String", # The mime type of the document.
+                    "uri": "A String", # The URI of the document.
                   },
-                ],
-                "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
-              },
-            ],
-          },
-          "googleSearchResult": { # Google Search result content.
-            "isError": True or False, # Whether the Google Search resulted in an error.
-            "result": [ # Required. The results of the Google Search.
-              { # The result of the Google Search.
-                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
-              },
-            ],
-          },
-          "mcpServerToolResult": { # MCPServer tool result content.
-            "contentList": {
-              "contents": [
-                {
                   "image": { # An image content block.
                     "data": "A String", # The image content.
                     "mimeType": "A String", # The mime type of the image.
@@ -8004,25 +24949,7 @@ 

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8050,701 +24977,583 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], }, + "contentString": "A String", # The content of the step. A single string. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. }, ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "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. }, }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -8769,25 +25578,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8830,25 +25621,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -8889,25 +25662,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -8927,25 +25682,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -8985,25 +25722,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9037,25 +25756,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -9101,25 +25802,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9153,551 +25836,686 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -9758,25 +26576,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9819,25 +26619,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -9878,25 +26660,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -9916,25 +26680,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -9974,25 +26720,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10026,25 +26754,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -10060,137 +26770,403 @@

Method Details

"url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -10261,25 +27237,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10322,25 +27280,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10381,25 +27321,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -10419,25 +27341,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -10477,25 +27381,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10529,25 +27415,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -10593,25 +27461,139 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10627,73 +27609,225 @@

Method Details

"title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -10746,25 +27880,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10807,25 +27923,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -10866,25 +27964,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -10904,25 +27984,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -10962,25 +28024,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -11014,25 +28058,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -11078,25 +28104,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -11107,640 +28115,292 @@

Method Details

"name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, ], + "text": "A String", # Required. The text content. }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -11752,201 +28412,216 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -11958,22 +28633,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -11986,25 +28657,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12035,152 +28688,386 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + "store": True or False, # Input only. Whether to store the response and request for later retrieval. + "stream": True or False, # Input only. Whether the interaction will be streamed. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { + "contentDelta": { # The content block delta data, used for content.delta events. + "delta": { # The delta content data for a content block. + "audio": { + "channels": 42, # The number of audio channels. + "data": "A String", + "mimeType": "A String", + "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", + }, + "document": { + "data": "A String", + "mimeType": "A String", + "uri": "A String", + }, + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "text": { + "text": "A String", + }, + "textAnnotation": { + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "thoughtSignature": { + "signature": "A String", # Signature to match the backend source to be part of the generation. + }, + "thoughtSummary": { + "content": { # The content of the response. # A new summary item to be added to the thought. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -12192,25 +29079,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12238,164 +29107,285 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + }, + "toolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "functionCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -12408,25 +29398,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12457,34 +29429,279 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -12496,22 +29713,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -12524,25 +29737,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12568,63 +29763,215 @@

Method Details

}, }, ], - "text": "A String", # Required. The text content. + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -12638,37 +29985,31 @@

Method Details

}, ], }, + "name": "A String", + "serverName": "A String", }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { + "arguments": { # The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "toolResult": { + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { + "isError": True or False, + "result": "A String", + }, + "fileSearchResult": { + "result": [ + { # The result of the File Search. }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. + "functionResult": { "contentList": { # A list of Content. "contents": [ # The contents of the list. { # The content of the response. @@ -12695,25 +30036,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12756,25 +30079,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12815,25 +30120,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -12853,25 +30140,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -12911,25 +30180,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -12963,25 +30214,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -13027,25 +30260,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13079,25 +30294,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -13119,8 +30316,8 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. + "isError": True or False, + "name": "A String", "stringResult": "A String", "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. @@ -13128,108 +30325,19 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -13241,25 +30349,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13287,141 +30377,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -13433,376 +30545,460 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", + "googleMapsResult": { + "result": [ # The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", + "googleSearchResult": { + "isError": True or False, + "result": [ + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "mcpServerToolResult": { + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "name": "A String", + "serverName": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -13814,25 +31010,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -13860,257 +31038,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -14122,152 +31206,124 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], + ], + }, }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, -}
-
- -
- createStream(projectsId, locationsId, body=None, x__xgafv=None) -
Creates an interaction and streams the response.
-
-Args:
-  projectsId: string, A parameter (required)
-  locationsId: string, A parameter (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Configuration parameters for creating an interaction.
-  "background": True or False, # Input only. Whether to run the model interaction in the background.
-  "interaction": { # Response for InteractionService.CreateInteraction. # The interaction to create.
-    "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents.
-      "agent": "A String", # The name of the `Agent` used for generating the completion.
-      "deepResearchConfig": { # Configuration for the Deep Research agent.
-        "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.
-        "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent.
-        "thinkingSummaries": "A String", # Whether to include thought summaries in the response.
-        "visualization": "A String", # Whether to include visualizations in the response.
-      },
-      "dynamicConfig": { # Configuration for dynamic agents.
-        "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition.
-          "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
-            { # Represents a single field in a struct.
-              "name": "A String",
-              "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
-                "boolValue": True or False, # Represents a boolean value.
-                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
-                  "values": [ # Repeated field of dynamically typed values.
-                    # Object with schema name: GenaiVertexV1beta1Value
-                  ],
-                },
-                "nullValue": "A String", # Represents a null value.
-                "numberValue": 3.14, # Represents a double value.
-                "stringValue": "A String", # Represents a string value.
-                "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value.
-              },
+        "signature": "A String", # A signature hash for backend validation.
+        "urlContextResult": {
+          "isError": True or False,
+          "result": [
+            { # The result of the URL context.
+              "status": "A String", # The status of the URL retrieval.
+              "url": "A String", # The URL that was fetched.
             },
           ],
         },
       },
+      "video": {
+        "data": "A String",
+        "mimeType": "A String",
+        "resolution": "A String", # The resolution of the media.
+        "uri": "A String",
+      },
     },
-    "content": { # The content of the response. # The content for the interaction.
+    "index": 42,
+  },
+  "contentStart": { # The content block start data, used for content.start events.
+    "content": { # The content of the response.
       "audio": { # An audio content block.
         "channels": 42, # The number of audio channels.
         "data": "A String", # The audio content.
@@ -14291,25 +31347,7 @@ 

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14352,25 +31390,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14411,25 +31431,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -14449,25 +31451,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -14507,25 +31491,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14559,25 +31525,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -14623,202 +31571,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -14832,118 +31585,88 @@

Method Details

{ # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, }, - }, + ], }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "index": 42, + }, + "contentStop": { # The content block stop data, used for content.stop events. + "index": 42, + }, + "errorEvent": { # The error event data, used for error events. + "error": { # Error message from an interaction. + "code": "A String", # A URI that identifies the error type. + "message": "A String", # A human-readable error message. + }, + }, + "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. + "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -14955,25 +31678,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15001,211 +31706,272 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, ], }, }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. + "content": { # The content of the response. # The content for the interaction. "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -15229,25 +31995,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15290,25 +32038,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15349,25 +32079,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -15387,25 +32099,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -15445,25 +32139,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15497,25 +32173,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -15561,25 +32219,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15613,25 +32253,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -15651,217 +32273,217 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -15873,18 +32495,22 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -15897,25 +32523,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -15946,189 +32554,252 @@

Method Details

}, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, + ], + "url": "A String", # URI reference of the place. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -16140,142 +32811,203 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "text": "A String", # Required. The text content. + "url": "A String", # URI reference of the place. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -16287,25 +33019,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -16333,456 +33047,45 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. "code": "A String", # The code to be executed. "language": "A String", # Programming language of the `code`. }, }, - "fileSearchCall": { # File Search call step. + "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps call step. + "googleMapsCall": { # Google Maps content. "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. "queries": [ # The queries to be executed. "A String", ], }, }, - "googleSearchCall": { # Google Search call step. + "googleSearchCall": { # Google Search content. "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. "queries": [ # Web search queries for the following-up web search. "A String", ], }, "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. + "urlContextCall": { # URL context content. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -16790,30 +33093,102 @@

Method Details

}, }, }, - "toolResult": { # Tool result step. + "toolResult": { # Tool result content. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. + "codeExecutionResult": { # Code execution result content. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result step. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -16825,25 +33200,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -16871,47 +33228,272 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -16923,112 +33505,164 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -17041,25 +33675,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17090,34 +33706,327 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -17129,182 +34038,244 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", }, - ], - "widgetContextToken": "A String", + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -17328,25 +34299,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17389,25 +34342,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17448,25 +34383,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -17486,25 +34403,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -17544,25 +34443,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17596,25 +34477,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -17660,25 +34523,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17712,25 +34557,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -17750,45 +34577,38 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, + }, + ], }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -17813,25 +34633,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17874,25 +34676,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -17933,25 +34717,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -17971,25 +34737,323 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -18027,27 +35091,9 @@

Method Details

"text": { # A text content block. "annotations": [ # Citation information for model-generated content. { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18081,25 +35127,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -18145,25 +35173,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -18197,25 +35207,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -18237,1232 +35229,1416 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "fileSearchCall": { # File Search call step. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + }, + ], }, + "name": "A String", # Required. The name of the tool to call. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "fileSearchResult": { # File Search result step. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "widgetContextToken": "A String", + }, + ], + }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -19475,25 +36651,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -19524,331 +36682,760 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -19860,201 +37447,174 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -20066,163 +37626,236 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "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. + }, }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -20247,25 +37880,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20303,30 +37918,12 @@

Method Details

"resolution": "A String", # The resolution of the media. "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20367,25 +37964,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -20405,25 +37984,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -20463,25 +38024,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20515,25 +38058,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -20579,25 +38104,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -20631,25 +38138,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -20671,359 +38160,755 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. + "fileSearchCall": { # File Search call step. }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. "A String", ], }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "top_k": 42, # Optional. The number of contexts to retrieve. + "searchType": "A String", # The type of search grounding enabled. }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. - }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + ], + }, + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -21036,579 +38921,613 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - "store": True or False, # Input only. Whether to store the response and request for later retrieval. - "stream": True or False, # Input only. Whether the interaction will be streamed. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { - "contentDelta": { # The content block delta data, used for content.delta events. - "delta": { # The delta content data for a content block. - "audio": { - "channels": 42, # The number of audio channels. - "data": "A String", - "mimeType": "A String", - "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", - }, - "document": { - "data": "A String", - "mimeType": "A String", - "uri": "A String", - }, - "image": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - "text": { - "text": "A String", - }, - "textAnnotation": { - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - }, - "thoughtSignature": { - "signature": "A String", # Signature to match the backend source to be part of the generation. - }, - "thoughtSummary": { - "content": { # The content of the response. # A new summary item to be added to the thought. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, ], }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", + }, + ], + "widgetContextToken": "A String", + }, + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -21620,25 +39539,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -21666,11 +39567,260 @@

Method Details

], "text": "A String", # Required. The text content. }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. @@ -21678,122 +39828,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -21809,7 +40145,7 @@

Method Details

}, }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. + "urlContextResult": { # URL context result step. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -21819,108 +40155,346 @@

Method Details

], }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - }, - "toolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { - }, - "functionCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + }, + "contentString": "A String", # The content of the step. A single string. }, - "name": "A String", }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. "A String", ], - }, - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", ], }, - "name": "A String", - "serverName": "A String", - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { - "arguments": { # The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. "A String", ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - }, - }, - "toolResult": { - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { - "isError": True or False, - "result": "A String", - }, - "fileSearchResult": { - "result": [ - { # The result of the File Search. - }, - ], - }, - "functionResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -21944,25 +40518,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22005,25 +40561,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22064,25 +40602,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -22102,25 +40622,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -22160,25 +40662,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22212,25 +40696,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -22276,25 +40742,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22328,25 +40776,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -22366,174 +40796,311 @@

Method Details

"uri": "A String", # The URI of the video. }, }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. }, - ], - }, - }, - "googleMapsResult": { - "result": [ # The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { - "isError": True or False, - "result": [ - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -22545,112 +41112,208 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + }, + ], + }, + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. + "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -22663,25 +41326,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -22712,283 +41357,542 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], + "text": "A String", # Required. The text content. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { - "isError": True or False, - "result": [ - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "contentStart": { # The content block start data, used for content.start events. - "content": { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -23000,25 +41904,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23046,141 +41932,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -23192,46 +42100,167 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -23243,22 +42272,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -23271,25 +42296,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -23311,865 +42318,320 @@

Method Details

"startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. "urlCitation": { # A URL citation annotation. # A URL citation annotation. "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "index": 42, - }, - "contentStop": { # The content block stop data, used for content.stop events. - "index": 42, - }, - "errorEvent": { # The error event data, used for error events. - "error": { # Error message from an interaction. - "code": "A String", # A URI that identifies the error type. - "message": "A String", # A human-readable error message. - }, - }, - "eventId": "A String", # The event_id token to be used to resume the interaction stream, from this event. - "interactionCompleteEvent": { # The interaction data, used for interaction.complete events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. + }, + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "fileSearchCall": { # File Search content. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - ], + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. + }, + ], }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -24181,23 +42643,266 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -24206,28 +42911,10 @@

Method Details

}, "text": { # A text content block. "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -24255,244 +42942,579 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", + }, ], }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -24506,188 +43528,371 @@

Method Details

}, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -24699,25 +43904,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -24745,185 +43932,256 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -24938,6 +44196,12 @@

Method Details

], }, }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). @@ -24974,25 +44238,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25035,25 +44281,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25094,25 +44322,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -25132,25 +44342,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -25190,25 +44382,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25242,25 +44416,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -25303,28 +44459,10 @@

Method Details

}, "text": { # A text content block. "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25358,25 +44496,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -25397,6 +44517,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -25425,25 +44554,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25486,25 +44597,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25545,25 +44638,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -25583,25 +44658,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -25641,25 +44698,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25693,25 +44732,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -25757,25 +44778,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -25809,25 +44812,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -25865,6 +44850,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -25903,6 +45190,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -25963,25 +45552,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26024,25 +45595,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26083,25 +45636,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -26121,25 +45656,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -26179,25 +45696,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26231,25 +45730,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -26295,25 +45776,139 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26344,58 +45939,210 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -26466,25 +46213,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26527,25 +46256,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26586,25 +46297,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -26624,25 +46317,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -26682,25 +46357,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26734,25 +46391,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -26798,25 +46437,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -26850,25 +46471,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -26899,6 +46502,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -26951,25 +46856,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27012,25 +46899,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27071,25 +46940,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -27109,25 +46960,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -27167,25 +47000,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27219,25 +47034,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -27283,25 +47080,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27335,25 +47114,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -27408,25 +47169,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27469,25 +47212,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27528,25 +47253,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -27566,25 +47273,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -27624,25 +47313,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27676,25 +47347,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -27740,25 +47393,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27792,25 +47427,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -27831,6 +47448,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -27859,25 +47485,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27920,25 +47528,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -27979,25 +47569,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -28017,25 +47589,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -28075,25 +47629,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28127,25 +47663,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -28191,25 +47709,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28243,25 +47743,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -28299,6 +47781,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -28337,6 +48121,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -28397,25 +48483,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28458,25 +48526,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28517,25 +48567,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -28555,25 +48587,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -28613,25 +48627,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28665,25 +48661,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -28729,25 +48707,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28781,25 +48741,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -28830,6 +48772,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -28900,25 +49144,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -28961,25 +49187,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -29020,25 +49228,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -29058,25 +49248,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -29116,25 +49288,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -29168,25 +49322,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -29232,25 +49368,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -29284,25 +49402,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -29333,108 +49433,19 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -29446,25 +49457,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -29492,257 +49485,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -29754,185 +49653,115 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", ], }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "top_k": 42, # Optional. The number of contexts to retrieve. - }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. @@ -29958,25 +49787,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -30019,25 +49830,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -30078,25 +49871,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -30116,25 +49891,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -30174,25 +49931,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -30226,25 +49965,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -30290,25 +50011,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -30342,25 +50045,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -30382,606 +50067,449 @@

Method Details

}, ], }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "contentString": "A String", # The content of the step. A single string. }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCompletedEvent": { # The interaction data, used for interaction.completed events. - "interaction": { # Response for InteractionService.CreateInteraction. # Required. The completed interaction with empty outputs to reduce the payload size. Use the preceding ContentDelta events for the actual output. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", ], }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. }, }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", ], - "text": "A String", # Required. The text content. + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -30993,25 +50521,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -31039,257 +50549,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -31301,448 +50717,166 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionCreatedEvent": { # The interaction data, used for interaction.created events. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -31754,25 +50888,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -31800,224 +50916,428 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. + ], }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -32029,25 +51349,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32075,400 +51377,170 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, + ], + "url": "A String", # URI reference of the place. }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -32480,25 +51552,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -32526,423 +51580,30 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, }, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. "code": "A String", # The code to be executed. "language": "A String", # Programming language of the `code`. }, }, - "fileSearchCall": { # File Search call step. + "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps call step. + "googleMapsCall": { # Google Maps content. "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. "queries": [ # The queries to be executed. "A String", ], }, }, - "googleSearchCall": { # Google Search call step. + "googleSearchCall": { # Google Search content. "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. "queries": [ # Web search queries for the following-up web search. "A String", @@ -32951,31 +51612,13 @@

Method Details

"searchType": "A String", # The type of search grounding enabled. }, "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. + "urlContextCall": { # URL context content. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -32983,30 +51626,22 @@

Method Details

}, }, }, - "toolResult": { # Tool result step. + "toolResult": { # Tool result content. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. + "codeExecutionResult": { # Code execution result content. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result step. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -33018,25 +51653,87 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33064,440 +51761,741 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. + }, + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", + "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -33521,25 +52519,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33582,25 +52562,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33641,25 +52603,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -33679,25 +52623,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -33737,25 +52663,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33786,28 +52694,10 @@

Method Details

}, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -33853,25 +52743,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -33905,25 +52777,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -33943,46 +52797,695 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -34006,25 +53509,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34067,25 +53552,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34126,25 +53593,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -34164,25 +53613,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -34222,25 +53653,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34274,25 +53687,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -34338,25 +53733,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34390,25 +53767,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -34428,128 +53787,563 @@

Method Details

"uri": "A String", # The URI of the video. }, }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - "contentString": "A String", # The content of the step. A single string. - }, + ], }, - ], + }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. + "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). + "A String", + ], + "role": "A String", # Output only. The role of the interaction. + "status": "A String", # Required. Output only. The status of the interaction. + "stepList": { # A list of Steps. # Input only. The steps for the interaction. + "steps": [ # The steps of the list. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -34561,113 +54355,119 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -34679,25 +54479,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34725,65 +54507,307 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, - ], - "url": "A String", # URI reference of the place. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -34795,25 +54819,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -34841,129 +54847,305 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context call step. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result step. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result step. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -34975,25 +55157,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -35021,257 +55185,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -35283,225 +55353,112 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -35513,25 +55470,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -35559,257 +55498,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -35821,190 +55666,460 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "googleMapsResult": { # Google Maps result step. + "result": [ + { # The result of the Google Maps. + "places": [ + { + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "widgetContextToken": "A String", }, ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "googleSearchResult": { # Google Search result step. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, ], }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -36016,25 +56131,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -36062,1044 +56159,493 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchCall": { # File Search content. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", - ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. - }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", - }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. - }, - }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, - }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", ], }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. + ], }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", - ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -37111,201 +56657,490 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - "fileSearchCall": { # File Search content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + }, + ], + }, + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + }, + "steps": [ # Required. Output only. The steps that make up the interaction. + { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - "text": "A String", # Required. The text content. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "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. + }, + }, + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -37317,1330 +57152,882 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionCreatedEvent": { # The interaction data, used for interaction.created events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. + ], + }, + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, ], }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -38658,7 +58045,7 @@

Method Details

"serverName": "A String", # Required. The name of the used MCP server. }, "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. + "urlContextCall": { # URL context call step. "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. "urls": [ # The URLs to fetch. "A String", @@ -38666,22 +58053,30 @@

Method Details

}, }, }, - "toolResult": { # Tool result content. + "toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. + "codeExecutionResult": { # Code execution result step. "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], + "fileSearchResult": { # File Search result step. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { + "functionResult": { # Result of a function tool call. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -38693,64 +58088,597 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -38765,28 +58693,28 @@

Method Details

], }, }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. + "googleMapsResult": { # Google Maps result step. + "result": [ { # The result of the Google Maps. - "places": [ # The places that were found. + "places": [ { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + "name": "A String", + "placeId": "A String", + "reviewSnippets": [ { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. + "url": "A String", }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "widgetContextToken": "A String", }, ], }, - "googleSearchResult": { # Google Search result content. + "googleSearchResult": { # Google Search result step. "isError": True or False, # Whether the Google Search resulted in an error. "result": [ # Required. The results of the Google Search. { # The result of the Google Search. @@ -38794,10 +58722,22 @@

Method Details

}, ], }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { + "mcpServerToolResult": { # MCPServer tool result step. + "contentList": { # A list of Content. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -38809,25 +58749,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -38855,285 +58777,280 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. - "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). - "A String", - ], - "role": "A String", # Output only. The role of the interaction. - "status": "A String", # Required. Output only. The status of the interaction. - "stepList": { # A list of Steps. # Input only. The steps for the interaction. - "steps": [ # The steps of the list. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "text": "A String", # Required. The text content. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -39145,25 +59062,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39191,257 +59090,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -39453,64 +59258,116 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. }, + ], + }, + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result step. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. + }, + "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only + "contentList": { # A list of Content. # The content of the step. An array of Content objects. + "contents": [ # The contents of the list. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -39535,25 +59392,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39596,25 +59435,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39655,25 +59476,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -39693,25 +59496,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -39751,25 +59536,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39803,25 +59570,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -39867,25 +59616,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -39919,25 +59650,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -39959,109 +59672,94 @@

Method Details

}, ], }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], + "contentString": "A String", # The content of the step. A single string. + }, + }, + ], + "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. + "systemInstruction": "A String", # System instruction for the interaction. + "tools": [ # A list of tool declarations the model may call during interaction. + { # A tool that can be used by the model. + "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. + }, + "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], + "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. + "environment": "A String", # The environment being operated. + "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. + "A String", + ], + }, + "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. + "fileSearchStoreNames": [ # The file search store names to search. + "A String", + ], + "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. + "topK": 42, # The number of semantic retrieval chunks to retrieve. + }, + "function": { # A tool that can be used by the model. # A function that can be used by the model. + "description": "A String", # A description of the function. + "name": "A String", # The name of the function. + "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -40073,25 +59771,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40119,512 +59799,465 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "name": "A String", # Required. The name of the tool to call. }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], + "text": "A String", # Required. The text content. }, }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. + "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. + "latitude": 3.14, # The latitude of the user's location. + "longitude": 3.14, # The longitude of the user's location. + }, + "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. + "searchTypes": [ # The types of search grounding to enable. + "A String", + ], + }, + "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. + "allowedTools": [ # The allowed tools. + { # The configuration for allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], + }, + ], + "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. + "a_key": "A String", + }, + "name": "A String", # The name of the MCPServer. + "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" + }, + "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. + "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. + "api_key": "A String", # Required. The API key for ExaAiSearch. + "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. + "a_key": "", # Properties of the object. + }, + }, + "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. + "api_key": "A String", # Optional. The API key for ParallelAiSearch. + "custom_config": { # Optional. Custom configs for ParallelAiSearch. + "a_key": "", # Properties of the object. + }, + }, + "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. + "rag_resources": [ # Optional. The representation of the rag source. + { # The definition of the Rag resource. + "rag_corpus": "A String", # Optional. RagCorpora resource name. + "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. + "filter": { # Config for filters. # Optional. Config for filters. + "metadata_filter": "A String", # Optional. String for metadata filtering. + "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. + "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. + }, + "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. + "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. + }, + "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. + "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. + "model_name": "A String", # Optional. The model name of the rank service. + }, + }, + "top_k": 42, # Optional. The number of contexts to retrieve. + }, + "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. + "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + "retrievalTypes": [ # The types of file retrieval to enable. + "A String", + ], + "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. + "datastores": [ # Optional. Used to specify Vertex AI Search datastores. + "A String", + ], + "engine": "A String", # Optional. Used to specify Vertex AI Search engine. + }, + }, + "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. + }, + }, + ], + "turnList": { # A list of Turns. # The turns for the interaction. + "turns": [ + { + "contentList": { # A list of Content. # The content of the turn. An array of Content objects. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "fileSearchCall": { # File Search content. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], - }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -40637,25 +60270,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -40669,375 +60284,192 @@

Method Details

{ # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. "reviewId": "A String", # The ID of the review snippet. "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. + "contentString": "A String", # The content of the turn. A single string. + "role": "A String", # The originator of this turn. Must be user for input or model for model output. + }, + ], + }, + "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + }, + }, + "interactionStartEvent": { # The interaction data, used for interaction.start events. + "interaction": { # Response for InteractionService.CreateInteraction. + "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. + "agent": "A String", # The name of the `Agent` used for generating the completion. + "deepResearchConfig": { # Configuration for the Deep Research agent. + "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. + "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "visualization": "A String", # Whether to include visualizations in the response. + }, + "dynamicConfig": { # Configuration for dynamic agents. + "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). "audio": { # An audio content block. "channels": 42, # The number of audio channels. "data": "A String", # The audio content. @@ -41061,25 +60493,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41122,25 +60536,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41181,25 +60577,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -41219,25 +60597,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -41277,25 +60637,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -41329,25 +60671,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -41358,666 +60682,570 @@

Method Details

"placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - }, - "steps": [ # Required. Output only. The steps that make up the interaction. - { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "fileSearchCall": { # File Search content. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + }, + ], + }, + }, + }, + "content": { # The content of the response. # The content for the interaction. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "contentList": { # A list of Content. # The inputs for the interaction. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, ], + "text": "A String", # Required. The text content. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, }, - ], - }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ { "image": { # An image content block. "data": "A String", # The image content. @@ -42030,25 +61258,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -42056,949 +61266,336 @@

Method Details

"source": "A String", # Source attributed for a portion of the text. }, "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], + "text": "A String", # Required. The text content. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + }, + ], }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, ], }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context call step. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "toolResult": { # Tool result step. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. + ], + }, + "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). + "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. + "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. + "id": "A String", # Required. Output only. A unique identifier for the interaction completion. + "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. + "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` + "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. + "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. + "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. + "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. + "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. + }, + "maxOutputTokens": 42, # The maximum number of tokens to include in the response. + "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. + "seed": 42, # Seed used in decoding for reproducibility. + "speechConfig": [ # Configuration for speech interaction. + { # The configuration for speech interaction. + "language": "A String", # The language of the speech. + "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. + "voice": "A String", # The voice of the speaker. }, - "fileSearchResult": { # File Search result step. + ], + "stopSequences": [ # A list of character sequences that will stop output interaction. + "A String", + ], + "temperature": 3.14, # Controls the randomness of the output. + "thinkingLevel": "A String", # The level of thought tokens that the model should generate. + "thinkingSummaries": "A String", # Whether to include thought summaries in the response. + "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. + "allowedTools": { # The configuration for allowed tools. # The allowed tools. + "mode": "A String", # The mode of the tool choice. + "tools": [ # The names of the allowed tools. + "A String", + ], }, - "functionResult": { # Result of a function tool call. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], + }, + "toolChoiceMode": "A String", # The mode of the tool choice. + "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. + "videoConfig": { # Configuration options for video generation. # Configuration for video generation. + "task": "A String", # Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media. + }, + }, + "model": "A String", # The name of the `Model` used for generating the completion. + }, + "outputs": [ # Output only. Responses from the model. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, + "searchType": "A String", # The type of search grounding enabled. }, - "googleMapsResult": { # Google Maps result step. - "result": [ - { # The result of the Google Maps. - "places": [ - { - "name": "A String", - "placeId": "A String", - "reviewSnippets": [ - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", - }, - ], - "widgetContextToken": "A String", - }, - ], + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "googleSearchResult": { # Google Search result step. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. }, ], }, - "mcpServerToolResult": { # MCPServer tool result step. - "contentList": { # A list of Content. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -43010,25 +61607,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -43056,380 +61635,85 @@

Method Details

], "text": "A String", # Required. The text content. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + "url": "A String", # URI reference of the place. }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. + ], + "text": "A String", # Required. The text content. }, }, ], @@ -43437,28 +61721,10 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result step. + "urlContextResult": { # URL context result content. "isError": True or False, # Whether the URL context resulted in an error. "result": [ # Required. The results of the URL context. { # The result of the URL context. @@ -43468,899 +61734,404 @@

Method Details

], }, }, - "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only - "contentList": { # A list of Content. # The content of the step. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + "previousInteractionId": "A String", # The ID of the previous interaction, if any. + "remoteEnvironment": { # Configuration for a custom environment. + "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. + "allowlist": [ # List of allowed domains and their configurations. + { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. + "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. + "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). + "a_key": "A String", + }, + }, + ], + }, + "networkMode": "A String", # Network egress mode. + "sources": [ + { # A source to be mounted into the environment. + "content": "A String", # The inline content if `type` is `INLINE`. + "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). + "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. + "target": "A String", # Where the source should appear in the environment. + "type": "A String", + }, + ], + }, + "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "text": "A String", # Required. The text content. }, - ], - }, - "contentString": "A String", # The content of the step. A single string. - }, - }, - ], - "stringContent": "A String", # A string input for the interaction, it will be processed as a single text input. - "systemInstruction": "A String", # System instruction for the interaction. - "tools": [ # A list of tool declarations the model may call during interaction. - { # A tool that can be used by the model. - "codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. - }, - "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. - "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. - "environment": "A String", # The environment being operated. - "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. - "A String", - ], - }, - "fileSearch": { # A tool that can be used by the model to search files. # A tool that can be used by the model to search files. - "fileSearchStoreNames": [ # The file search store names to search. - "A String", + }, ], - "metadataFilter": "A String", # Metadata filter to apply to the semantic retrieval documents and chunks. - "topK": 42, # The number of semantic retrieval chunks to retrieve. }, - "function": { # A tool that can be used by the model. # A function that can be used by the model. - "description": "A String", # A description of the function. - "name": "A String", # The name of the function. - "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - "googleMaps": { # A tool that can be used by the model to call Google Maps. # A tool that can be used by the model to search Google Maps. - "enableWidget": True or False, # Whether to return a widget context token in the tool call result of the response. - "latitude": 3.14, # The latitude of the user's location. - "longitude": 3.14, # The longitude of the user's location. - }, - "googleSearch": { # A tool that can be used by the model to search Google. # A tool that can be used by the model to search Google. - "searchTypes": [ # The types of search grounding to enable. - "A String", - ], - }, - "mcpServer": { # A MCPServer is a server that can be called by the model to perform actions. # A MCPServer is a server that can be called by the model to perform actions. - "allowedTools": [ # The allowed tools. - { # The configuration for allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. "A String", ], }, - ], - "headers": { # Optional: Fields for authentication headers, timeouts, etc., if needed. - "a_key": "A String", }, - "name": "A String", # The name of the MCPServer. - "url": "A String", # The full URL for the MCPServer endpoint. Example: "https://api.example.com/mcp" - }, - "retrieval": { # A tool that can be used by the model to retrieve files. # A tool that can be used by the model to retrieve files. - "exa_ai_search_config": { # Used to specify configuration for ExaAISearch. # Used to specify configuration for ExaAISearch. - "api_key": "A String", # Required. The API key for ExaAiSearch. - "custom_config": { # Optional. This field can be used to pass any parameter from the Exa.ai Search API. - "a_key": "", # Properties of the object. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - "parallel_ai_search_config": { # Used to specify configuration for ParallelAISearch. # Used to specify configuration for ParallelAISearch. - "api_key": "A String", # Optional. The API key for ParallelAiSearch. - "custom_config": { # Optional. Custom configs for ParallelAiSearch. - "a_key": "", # Properties of the object. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. }, - "rag_store_config": { # Use to specify configuration for RAG Store. # Used to specify configuration for RagStore. - "rag_resources": [ # Optional. The representation of the rag source. - { # The definition of the Rag resource. - "rag_corpus": "A String", # Optional. RagCorpora resource name. - "rag_file_ids": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "rag_retrieval_config": { # Specifies the context retrieval config. # Optional. The retrieval config for the Rag query. - "filter": { # Config for filters. # Optional. Config for filters. - "metadata_filter": "A String", # Optional. String for metadata filtering. - "vector_distance_threshold": 3.14, # Optional. Only returns contexts with vector distance smaller than the threshold. - "vector_similarity_threshold": 3.14, # Optional. Only returns contexts with vector similarity larger than the threshold. - }, - "hybrid_search": { # Config for Hybrid Search. # Optional. Config for Hybrid Search. - "alpha": 3.14, # Optional. Alpha value controls the weight between dense and sparse vector search results. - }, - "ranking": { # Config for ranking and reranking. # Optional. Config for ranking and reranking. - "rank_service": { # Config for Rank Service. # Optional. Config for Rank Service. - "model_name": "A String", # Optional. The model name of the rank service. - }, - }, - "top_k": 42, # Optional. The number of contexts to retrieve. + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], }, - "similarity_top_k": 42, # Optional. Number of top k results to return from the selected corpora. - "vector_distance_threshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. }, - "retrievalTypes": [ # The types of file retrieval to enable. - "A String", - ], - "vertex_ai_search_config": { # Used to specify configuration for VertexAISearch. # Used to specify configuration for VertexAISearch. - "datastores": [ # Optional. Used to specify Vertex AI Search datastores. - "A String", + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, ], - "engine": "A String", # Optional. Used to specify Vertex AI Search engine. }, - }, - "urlContext": { # A tool that can be used by the model to fetch URL context. # A tool that can be used by the model to fetch URL context. - }, - }, - ], - "turnList": { # A list of Turns. # The turns for the interaction. - "turns": [ - { - "contentList": { # A list of Content. # The content of the turn. An array of Content objects. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], + "url": "A String", # URI reference of the place. }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "responseFormatList": { + "responseFormats": [ + { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -44372,22 +62143,18 @@

Method Details

], "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. { "image": { # An image content block. "data": "A String", # The image content. @@ -44400,25 +62167,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -44449,541 +62198,210 @@

Method Details

}, ], }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "contentString": "A String", # The content of the turn. A single string. - "role": "A String", # The originator of this turn. Must be user for input or model for model output. - }, - ], - }, - "updated": "A String", # Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "usage": { # Statistics on the interaction request's token usage. # Output only. Statistics on the interaction request's token usage. - "cachedTokensByModality": [ # A breakdown of cached token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "groundingToolCount": [ # Grounding tool count. - { # The number of grounding tool counts. - "count": 42, # The number of grounding tool counts. - "type": "A String", # The grounding tool type associated with the count. - }, - ], - "inputTokensByModality": [ # A breakdown of input token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "outputTokensByModality": [ # A breakdown of output token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. - { # The token count for a single response modality. - "modality": "A String", # The modality associated with the token count. - "tokens": 42, # Number of tokens for the modality. - }, - ], - "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). - "totalInputTokens": 42, # Number of tokens in the prompt (context). - "totalOutputTokens": 42, # Total number of tokens across all the generated responses. - "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. - "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). - "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). - }, - }, - }, - "interactionStartEvent": { # The interaction data, used for interaction.start events. - "interaction": { # Response for InteractionService.CreateInteraction. - "agentInteraction": { # Interaction for generating the completion using agents. # Interaction for generating the completion using agents. - "agent": "A String", # The name of the `Agent` used for generating the completion. - "deepResearchConfig": { # Configuration for the Deep Research agent. - "collaborativePlanning": True or False, # Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn. - "enableBigqueryTool": True or False, # Enables bigquery tool for the Deep Research agent. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "visualization": "A String", # Whether to include visualizations in the response. - }, - "dynamicConfig": { # Configuration for dynamic agents. - "config": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # For agents that are not supported statically in the API definition. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - }, - "content": { # The content of the response. # The content for the interaction. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "fileSearchCall": { # File Search content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -44997,101 +62415,371 @@

Method Details

}, ], }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - "contentList": { # A list of Content. # The inputs for the interaction. - "contents": [ # The contents of the list. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, }, - }, - ], - "text": "A String", # Required. The text content. + ], + }, }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, + }, + ], + }, + "responseFormatSingleton": { + "audio": { # Configuration for audio output format. + "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + "delivery": "A String", # The delivery mode for the audio output. + "mimeType": "A String", # The MIME type of the audio output. + "sampleRate": 42, # Sample rate in Hz. + }, + "image": { # Configuration for image output format. + "aspectRatio": "A String", # The aspect ratio for the image output. + "delivery": "A String", # The delivery mode for the image output. + "imageSize": "A String", # The size of the image output. + "mimeType": "A String", # The MIME type of the image output. + }, + "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -45103,25 +62791,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45149,594 +62819,290 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "created": "A String", # Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). - "envId": "A String", # The environment ID for the interaction. Can be 'remote' for default environment. - "environmentId": "A String", # Output only. The environment ID for the interaction. Only populated if environment config is set in the request. - "id": "A String", # Required. Output only. A unique identifier for the interaction completion. - "modelInteraction": { # Interaction for generating the completion using models. # Interaction for generating the completion using models. - "cached_content": "A String", # The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}` - "generationConfig": { # Configuration parameters for model interactions. # Input only. Configuration parameters for the model interaction. - "frequency_penalty": 3.14, # Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. - "imageConfig": { # The configuration for image interaction. # Configuration for image interaction. - "aspectRatio": "A String", # The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided. - "imageSize": "A String", # Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`. - }, - "maxOutputTokens": 42, # The maximum number of tokens to include in the response. - "presence_penalty": 3.14, # Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. - "seed": 42, # Seed used in decoding for reproducibility. - "speechConfig": [ # Configuration for speech interaction. - { # The configuration for speech interaction. - "language": "A String", # The language of the speech. - "speaker": "A String", # The speaker's name, it should match the speaker name given in the prompt. - "voice": "A String", # The voice of the speaker. - }, - ], - "stopSequences": [ # A list of character sequences that will stop output interaction. - "A String", - ], - "temperature": 3.14, # Controls the randomness of the output. - "thinkingLevel": "A String", # The level of thought tokens that the model should generate. - "thinkingSummaries": "A String", # Whether to include thought summaries in the response. - "toolChoiceConfig": { # The tool choice configuration containing allowed tools. # The config for the tool choice. - "allowedTools": { # The configuration for allowed tools. # The allowed tools. - "mode": "A String", # The mode of the tool choice. - "tools": [ # The names of the allowed tools. - "A String", - ], - }, - }, - "toolChoiceMode": "A String", # The mode of the tool choice. - "topP": 3.14, # The maximum cumulative probability of tokens to consider when sampling. - }, - "model": "A String", # The name of the `Model` used for generating the completion. - }, - "outputs": [ # Output only. Responses from the model. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "text": "A String", # Required. The text content. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "text": { # Configuration for text output format. + "mimeType": "A String", # The MIME type of the text output. + "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -45748,25 +63114,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -45794,301 +63142,256 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], + ], + "text": "A String", # Required. The text content. + }, }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. }, ], - "url": "A String", # URI reference of the place. + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - "previousInteractionId": "A String", # The ID of the previous interaction, if any. - "remoteEnvironment": { # Configuration for a custom environment. - "networkAllowlist": { # Network egress configuration for the environment. # Allow only specific domains. - "allowlist": [ # List of allowed domains and their configurations. - { # A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request. - "domain": "A String", # The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains. - "transform": { # Headers to inject into requests matching this rule. Key: header name (e.g., "Authorization"). Value: header value (e.g., "Bearer your-token"). - "a_key": "A String", - }, - }, - ], - }, - "networkMode": "A String", # Network egress mode. - "sources": [ - { # A source to be mounted into the environment. - "content": "A String", # The inline content if `type` is `INLINE`. - "encoding": "A String", # Optional encoding for inline content (e.g. `base64`). - "source": "A String", # The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path. - "target": "A String", # Where the source should appear in the environment. - "type": "A String", - }, - ], - }, - "responseFormat": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - "responseFormatList": { - "responseFormats": [ - { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - ], - }, - }, - }, - ], - }, - "responseFormatSingleton": { - "audio": { # Configuration for audio output format. - "bitRate": 42, # Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). - "delivery": "A String", # The delivery mode for the audio output. - "mimeType": "A String", # The MIME type of the audio output. - "sampleRate": 42, # Sample rate in Hz. - }, - "image": { # Configuration for image output format. - "aspectRatio": "A String", # The aspect ratio for the image output. - "delivery": "A String", # The delivery mode for the image output. - "imageSize": "A String", # The size of the image output. - "mimeType": "A String", # The MIME type of the image output. - }, - "structValue": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Multi-discriminator values is already enabled in GAOS - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "text": { # Configuration for text output format. - "mimeType": "A String", # The MIME type of the text output. - "schema": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # The JSON schema that the output should conform to. Only applicable when mime_type is application/json. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -46103,6 +63406,12 @@

Method Details

], }, }, + "video": { # Configuration for video output format. + "aspectRatio": "A String", # The aspect ratio for the video output. + "delivery": "A String", # The delivery mode for the video output. + "duration": "A String", # The duration for the video output. + "gcsUri": "A String", # The GCS URI to store the video output. Required for Vertex if delivery mode is URI. + }, }, "responseMimeType": "A String", # The mime type of the response. This is required if response_format is set. "responseModalities": [ # The requested modalities of the response (TEXT, IMAGE, AUDIO). @@ -46139,25 +63448,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46200,25 +63491,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46259,25 +63532,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -46297,25 +63552,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -46355,25 +63592,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46407,25 +63626,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -46471,25 +63672,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46523,25 +63706,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -46562,6 +63727,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -46590,25 +63764,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46651,25 +63807,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46710,25 +63848,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -46748,25 +63868,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -46806,25 +63908,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46858,25 +63942,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -46922,25 +63988,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -46974,25 +64022,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -47030,6 +64060,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -47068,6 +64400,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -47128,25 +64762,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47189,25 +64805,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47248,25 +64846,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -47286,25 +64866,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -47344,25 +64906,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47396,25 +64940,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -47460,25 +64986,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47512,25 +65020,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -47561,6 +65051,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -47631,25 +65423,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47692,25 +65466,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47751,25 +65507,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -47789,25 +65527,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -47847,25 +65567,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -47899,25 +65601,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -47963,25 +65647,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48015,25 +65681,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -48064,6 +65712,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -48116,25 +66066,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48177,25 +66109,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48236,25 +66150,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -48274,25 +66170,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -48332,25 +66210,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48384,25 +66244,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -48448,25 +66290,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48500,25 +66324,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -48573,25 +66379,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48634,25 +66422,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48693,25 +66463,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -48731,25 +66483,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -48789,25 +66523,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48841,25 +66557,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -48905,25 +66603,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -48957,25 +66637,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -48996,6 +66658,15 @@

Method Details

}, }, ], + "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. + }, }, "thought": { # A thought step. "signature": "A String", # A signature hash for backend validation. @@ -49024,25 +66695,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49085,25 +66738,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49144,25 +66779,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -49182,25 +66799,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -49240,25 +66839,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49292,25 +66873,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -49356,25 +66919,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49407,26 +66952,8 @@

Method Details

}, "name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -49464,6 +66991,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -49502,6 +67331,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -49562,25 +67693,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49623,25 +67736,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49682,25 +67777,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -49720,25 +67797,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -49778,25 +67837,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49830,25 +67871,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -49894,25 +67917,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -49946,25 +67951,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -49995,6 +67982,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -50065,25 +68354,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50126,25 +68397,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50185,25 +68438,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -50223,25 +68458,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -50281,25 +68498,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50333,25 +68532,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -50397,25 +68578,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50449,25 +68612,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -50498,6 +68643,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -50550,25 +68997,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50611,25 +69040,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50670,25 +69081,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -50708,25 +69101,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -50766,25 +69141,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50818,25 +69175,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -50882,25 +69221,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -50934,25 +69255,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -50985,6 +69288,9 @@

Method Details

"codeExecution": { # A tool that can be used by the model to execute code. # A tool that can be used by the model to execute code. }, "computerUse": { # A tool that can be used by the model to interact with the computer. # Tool to support the model interacting directly with the computer. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Whether enable the prompt injection detection check on computer-use request. "environment": "A String", # The environment being operated. "excludedPredefinedFunctions": [ # The list of predefined functions that are excluded from the model call. @@ -51003,6 +69309,308 @@

Method Details

"name": "A String", # The name of the function. "parameters": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # The JSON Schema for the function's parameters. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -51123,25 +69731,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -51184,25 +69774,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -51243,25 +69815,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -51281,25 +69835,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -51339,25 +69875,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -51391,25 +69909,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -51455,25 +69955,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -51507,25 +69989,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -51682,56 +70146,660 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, + "name": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], }, }, - ], - "text": "A String", # Required. The text content. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value + ], + }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { + }, + ], + }, + }, + "image": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + "serverToolCall": { + "codeExecutionCall": { + "arguments": { # The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { + }, + "googleMapsCall": { + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { + "arguments": { # The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + }, + "mcpServerToolCall": { + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, "image": { # An image content block. "data": "A String", # The image content. "mimeType": "A String", # The mime type of the image. @@ -51743,25 +70811,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -51789,257 +70839,163 @@

Method Details

], "text": "A String", # Required. The text content. }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. + ], }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, - }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], }, + "searchType": "A String", # The type of search grounding enabled. }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], + "url": "A String", # URI reference of the place. }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { "name": "A String", # Title of the place. "placeId": "A String", # The ID of the place, in `places/{place_id}` format. "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. @@ -52051,120 +71007,88 @@

Method Details

], "url": "A String", # URI reference of the place. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, }, ], - "text": "A String", # Required. The text content. }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, - "name": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - }, - "image": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - "serverToolCall": { - "codeExecutionCall": { - "arguments": { # The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { - }, - "googleMapsCall": { - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { - "arguments": { # The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - }, - "mcpServerToolCall": { - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -52257,25 +71181,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52318,25 +71224,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52377,25 +71265,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -52415,25 +71285,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -52473,25 +71325,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52525,25 +71359,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -52589,107 +71405,373 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "name": "A String", + "serverName": "A String", + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, - }, - ], - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + ], + "url": "A String", # URI reference of the place. }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. - }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + ], }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - ], + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "name": "A String", - "serverName": "A String", - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -52723,25 +71805,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52796,25 +71860,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52857,25 +71903,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -52916,25 +71944,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -52954,25 +71964,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -53012,25 +72004,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53064,25 +72038,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -53128,25 +72084,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53170,69 +72108,367 @@

Method Details

"title": "A String", # The title of the URL. "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + }, + "video": { + "data": "A String", + "mimeType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", + }, + }, + "index": 42, + }, + "stepStart": { # The step start data, used for step.start events. + "index": 42, + "step": { # A step in the interaction. + "modelOutput": { # Output generated by the model. + "content": [ + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, ], + "text": "A String", # Required. The text content. }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], }, }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, + ], + "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. }, }, - "video": { - "data": "A String", - "mimeType": "A String", - "resolution": "A String", # The resolution of the media. - "uri": "A String", - }, - }, - "index": 42, - }, - "stepStart": { # The step start data, used for step.start events. - "index": 42, - "step": { # A step in the interaction. - "modelOutput": { # Output generated by the model. - "content": [ + "thought": { # A thought step. + "signature": "A String", # A signature hash for backend validation. + "summary": [ # A summary of the thought. { # The content of the response. "audio": { # An audio content block. "channels": 42, # The number of audio channels. @@ -53257,25 +72493,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53318,25 +72536,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53377,25 +72577,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -53415,25 +72597,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -53473,25 +72637,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53525,25 +72671,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -53589,25 +72717,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -53641,25 +72751,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -53681,511 +72773,664 @@

Method Details

}, ], }, - "thought": { # A thought step. - "signature": "A String", # A signature hash for backend validation. - "summary": [ # A summary of the thought. - { # The content of the response. - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeType": "A String", # The mime type of the audio. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeType": "A String", # The mime type of the document. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "toolCall": { # Tool call step. + "codeExecutionCall": { # Code execution call step. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search call step. + }, + "functionCall": { # A function tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, + "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. + "values": [ # Repeated field of dynamically typed values. + # Object with schema name: GenaiVertexV1beta1Value ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + "nullValue": "A String", # Represents a null value. + "numberValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, - ], - "text": "A String", # Required. The text content. - }, - "thought": { # A thought content block. - "signature": "A String", # Signature to match the backend source to be part of the generation. - "summary": [ # A summary of the thought. - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + }, + ], + }, + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps call step. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search call step. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call step. + "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], }, }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "toolCall": { # Tool call content. - "codeExecutionCall": { # Code execution content. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search content. - }, - "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "searchType": "A String", # The type of search grounding enabled. }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps content. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search content. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. }, }, - ], - }, - "name": "A String", # Required. The name of the tool which was called. - "serverName": "A String", # Required. The name of the used MCP server. - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextCall": { # URL context content. - "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. - "urls": [ # The URLs to fetch. - "A String", - ], - }, - }, - }, - "toolResult": { # Tool result content. - "callId": "A String", # Required. ID to match the ID from the function call block. - "codeExecutionResult": { # Code execution result content. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result content. - "result": [ # Optional. The results of the File Search. - { # The result of the File Search. - }, - ], - }, - "functionResult": { # A function tool result content block. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, - }, - ], - "text": "A String", # Required. The text content. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, - }, - ], - }, - }, - "googleMapsResult": { # Google Maps result content. - "result": [ # Required. The results of the Google Maps. - { # The result of the Google Maps. - "places": [ # The places that were found. - { - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. }, ], - "url": "A String", # URI reference of the place. }, - ], - "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. - }, - ], - }, - "googleSearchResult": { # Google Search result content. - "isError": True or False, # Whether the Google Search resulted in an error. - "result": [ # Required. The results of the Google Search. - { # The result of the Google Search. - "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. - }, - ], - }, - "mcpServerToolResult": { # MCPServer tool result content. - "contentList": { - "contents": [ - { - "image": { # An image content block. - "data": "A String", # The image content. - "mimeType": "A String", # The mime type of the image. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. }, }, ], + "text": "A String", # Required. The text content. }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. - }, - ], - "url": "A String", # URI reference of the place. - }, - "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. - "urlCitation": { # A URL citation annotation. # A URL citation annotation. - "title": "A String", # The title of the URL. - "url": "A String", # The URL. }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, ], - "text": "A String", # Required. The text content. }, }, - ], - }, - "name": "A String", # Name of the tool which is called for this specific tool call. - "serverName": "A String", # The name of the used MCP server. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. - }, - ], - }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "toolCall": { # Tool call step. - "codeExecutionCall": { # Code execution call step. - "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. - "code": "A String", # The code to be executed. - "language": "A String", # Programming language of the `code`. - }, - }, - "fileSearchCall": { # File Search call step. - }, - "functionCall": { # A function tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, - "name": "A String", # Required. The name of the tool to call. - }, - "googleMapsCall": { # Google Maps call step. - "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. - "queries": [ # The queries to be executed. - "A String", - ], - }, - }, - "googleSearchCall": { # Google Search call step. - "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. - "queries": [ # Web search queries for the following-up web search. - "A String", - ], - }, - "searchType": "A String", # The type of search grounding enabled. - }, - "id": "A String", # Required. A unique ID for this specific tool call. - "mcpServerToolCall": { # MCPServer tool call step. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -54246,25 +73491,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54307,25 +73534,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54366,25 +73575,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -54404,25 +73595,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -54462,25 +73635,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54514,25 +73669,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -54578,25 +73715,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54630,55 +73749,339 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. + "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. + { # Represents a single field in a struct. + "name": "A String", + "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. }, - }, - ], - }, - }, - "signature": "A String", # A signature hash for backend validation. - "urlContextResult": { # URL context result content. - "isError": True or False, # Whether the URL context resulted in an error. - "result": [ # Required. The results of the URL context. - { # The result of the URL context. - "status": "A String", # The status of the URL retrieval. - "url": "A String", # The URL that was fetched. + ], }, - ], + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, }, - }, - "video": { # A video content block. - "data": "A String", # The video content. - "mimeType": "A String", # The mime type of the video. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the video. - }, - }, - ], - }, - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -54749,25 +74152,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54810,25 +74195,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -54869,25 +74236,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -54907,25 +74256,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -54965,25 +74296,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55017,25 +74330,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -55081,25 +74376,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55133,25 +74410,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -55182,6 +74441,308 @@

Method Details

"name": "A String", "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeType": "A String", # The mime type of the audio. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeType": "A String", # The mime type of the document. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "thought": { # A thought content block. + "signature": "A String", # Signature to match the backend source to be part of the generation. + "summary": [ # A summary of the thought. + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "toolCall": { # Tool call content. + "codeExecutionCall": { # Code execution content. + "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution. + "code": "A String", # The code to be executed. + "language": "A String", # Programming language of the `code`. + }, + }, + "fileSearchCall": { # File Search content. + }, + "functionCall": { # A function tool call content block. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. + "name": "A String", # Required. The name of the tool to call. + }, + "googleMapsCall": { # Google Maps content. + "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool. + "queries": [ # The queries to be executed. + "A String", + ], + }, + }, + "googleSearchCall": { # Google Search content. + "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search. + "queries": [ # Web search queries for the following-up web search. + "A String", + ], + }, + "searchType": "A String", # The type of search grounding enabled. + }, + "id": "A String", # Required. A unique ID for this specific tool call. + "mcpServerToolCall": { # MCPServer tool call content. + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. + "name": "A String", # Required. The name of the tool which was called. + "serverName": "A String", # Required. The name of the used MCP server. + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextCall": { # URL context content. + "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context. + "urls": [ # The URLs to fetch. + "A String", + ], + }, + }, + }, + "toolResult": { # Tool result content. + "callId": "A String", # Required. ID to match the ID from the function call block. + "codeExecutionResult": { # Code execution result content. + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result content. + "result": [ # Optional. The results of the File Search. + { # The result of the File Search. + }, + ], + }, + "functionResult": { # A function tool result content block. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "googleMapsResult": { # Google Maps result content. + "result": [ # Required. The results of the Google Maps. + { # The result of the Google Maps. + "places": [ # The places that were found. + { + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + ], + "widgetContextToken": "A String", # Resource name of the Google Maps widget context token. + }, + ], + }, + "googleSearchResult": { # Google Search result content. + "isError": True or False, # Whether the Google Search resulted in an error. + "result": [ # Required. The results of the Google Search. + { # The result of the Google Search. + "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview. + }, + ], + }, + "mcpServerToolResult": { # MCPServer tool result content. + "contentList": { + "contents": [ + { + "image": { # An image content block. + "data": "A String", # The image content. + "mimeType": "A String", # The mime type of the image. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + }, + ], + }, + "name": "A String", # Name of the tool which is called for this specific tool call. + "serverName": "A String", # The name of the used MCP server. + "stringResult": "A String", + "structResult": # Object with schema name: GenaiVertexV1beta1Struct + }, + "signature": "A String", # A signature hash for backend validation. + "urlContextResult": { # URL context result content. + "isError": True or False, # Whether the URL context resulted in an error. + "result": [ # Required. The results of the URL context. + { # The result of the URL context. + "status": "A String", # The status of the URL retrieval. + "url": "A String", # The URL that was fetched. + }, + ], + }, + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeType": "A String", # The mime type of the video. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. "values": [ # Repeated field of dynamically typed values. # Object with schema name: GenaiVertexV1beta1Value @@ -55234,25 +74795,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55295,25 +74838,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55354,25 +74879,7 @@

Method Details

"fileSearchCall": { # File Search content. }, "functionCall": { # A function tool call content block. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The arguments to pass to the function. "name": "A String", # Required. The name of the tool to call. }, "googleMapsCall": { # Google Maps content. @@ -55392,25 +74899,7 @@

Method Details

}, "id": "A String", # Required. A unique ID for this specific tool call. "mcpServerToolCall": { # MCPServer tool call content. - "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "arguments": # Object with schema name: GenaiVertexV1beta1Struct # Required. The JSON object of arguments for the function. "name": "A String", # Required. The name of the tool which was called. "serverName": "A String", # Required. The name of the used MCP server. }, @@ -55450,25 +74939,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55502,25 +74973,7 @@

Method Details

"isError": True or False, # Whether the tool call resulted in an error. "name": "A String", # The name of the tool that was called. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "googleMapsResult": { # Google Maps result content. "result": [ # Required. The results of the Google Maps. @@ -55566,25 +75019,7 @@

Method Details

{ # Citation information for model-generated content. "endIndex": 42, # End of the attributed segment, exclusive. "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # User provided metadata about the retrieved context. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "customMetadata": # Object with schema name: GenaiVertexV1beta1Struct # User provided metadata about the retrieved context. "documentUri": "A String", # The URI of the file. "fileName": "A String", # The name of the file. "mediaId": "A String", # Media ID in-case of image citations, if applicable. @@ -55618,25 +75053,7 @@

Method Details

"name": "A String", # Name of the tool which is called for this specific tool call. "serverName": "A String", # The name of the used MCP server. "stringResult": "A String", - "structResult": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. - "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control. - { # Represents a single field in a struct. - "name": "A String", - "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. - "boolValue": True or False, # Represents a boolean value. - "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`. - "values": [ # Repeated field of dynamically typed values. - # Object with schema name: GenaiVertexV1beta1Value - ], - }, - "nullValue": "A String", # Represents a null value. - "numberValue": 3.14, # Represents a double value. - "stringValue": "A String", # Represents a string value. - "structValue": # Object with schema name: GenaiVertexV1beta1Struct # Represents a structured value. - }, - }, - ], - }, + "structResult": # Object with schema name: GenaiVertexV1beta1Struct }, "signature": "A String", # A signature hash for backend validation. "urlContextResult": { # URL context result content. @@ -55664,6 +75081,82 @@

Method Details

}, "stepStop": { # The step stop data, used for step.stop events. "index": 42, + "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, + "usage": { # Statistics on the interaction request's token usage. # Cumulative model usage stats from the start of the session. + "cachedTokensByModality": [ # A breakdown of cached token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "groundingToolCount": [ # Grounding tool count. + { # The number of grounding tool counts. + "count": 42, # The number of grounding tool counts. + "type": "A String", # The grounding tool type associated with the count. + }, + ], + "inputTokensByModality": [ # A breakdown of input token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "outputTokensByModality": [ # A breakdown of output token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "toolUseTokensByModality": [ # A breakdown of tool-use token usage by modality. + { # The token count for a single response modality. + "modality": "A String", # The modality associated with the token count. + "tokens": 42, # Number of tokens for the modality. + }, + ], + "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content). + "totalInputTokens": 42, # Number of tokens in the prompt (context). + "totalOutputTokens": 42, # Total number of tokens across all the generated responses. + "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models. + "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens). + "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s). + }, }, }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html new file mode 100644 index 0000000000..0e729efad6 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html @@ -0,0 +1,96 @@ + + + +

Agent Platform API . projects . locations . memoryBanks

+

Instance Methods

+

+ memories() +

+

Returns the memories Resource.

+ +

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html new file mode 100644 index 0000000000..ad896ad82b --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html @@ -0,0 +1,150 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories

+

Instance Methods

+

+ operations() +

+

Returns the operations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a Memory.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a Memory.
+
+Args:
+  name: string, Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A memory.
+  "createTime": "A String", # Output only. Represents the timestamp when this Memory was created.
+  "description": "A String", # Optional. Represents the description of the Memory.
+  "disableMemoryRevisions": True or False, # Optional. Input only. Indicates whether no revision will be created for this request.
+  "displayName": "A String", # Optional. Represents the display name of the Memory.
+  "expireTime": "A String", # Optional. Represents the timestamp of when this resource is considered expired. This is *always* provided on output when `expiration` is set on input, regardless of whether `expire_time` or `ttl` was provided.
+  "fact": "A String", # Optional. Represents semantic knowledge extracted from the source content.
+  "memoryType": "A String", # Optional. Represents the type of the memory. If not set, the `NATURAL_LANGUAGE_COLLECTION` type is used. If `STRUCTURED_COLLECTION` or `STRUCTURED_PROFILE` is used, then `structured_data` must be provided.
+  "metadata": { # Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.
+    "a_key": { # Memory metadata.
+      "boolValue": True or False, # Represents a boolean value.
+      "doubleValue": 3.14, # Represents a double value.
+      "stringValue": "A String", # Represents a string value.
+      "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared.
+    },
+  },
+  "name": "A String", # Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`
+  "revisionExpireTime": "A String", # Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.
+  "revisionLabels": { # Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.
+    "a_key": "A String",
+  },
+  "revisionTtl": "A String", # Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.
+  "scope": { # Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.
+    "a_key": "A String",
+  },
+  "structuredContent": { # Represents the structured value of the memory. # Optional. Represents the structured content of the memory.
+    "data": { # Required. Represents the structured value of the memory.
+      "a_key": "", # Properties of the object.
+    },
+    "schemaId": "A String", # Required. Represents the schema ID for which this structured memory belongs to.
+  },
+  "topics": [ # Optional. Represents the Topics of the Memory.
+    { # A memory topic identifier. This will be used to label a Memory and to restrict which topics are eligible for generation or retrieval.
+      "customMemoryTopicLabel": "A String", # Optional. Represents the custom memory topic label.
+      "managedMemoryTopic": "A String", # Optional. Represents the managed memory topic.
+    },
+  ],
+  "ttl": "A String", # Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.
+  "updateTime": "A String", # Output only. Represents the timestamp when this Memory was most recently updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.operations.html new file mode 100644 index 0000000000..bf2b043cb1 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . memories . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.operations.html new file mode 100644 index 0000000000..2ea006cca8 --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.operations.html @@ -0,0 +1,272 @@ + + + +

Agent Platform API . projects . locations . memoryBanks . operations

+

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

+

+ list_next()

+

Retrieves the next page of results.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

+

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+  name: string, The name of the operation's parent resource. (required)
+  filter: string, The standard list filter.
+  pageSize: integer, The standard list page size.
+  pageToken: string, The standard list page token.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response message for Operations.ListOperations.
+  "nextPageToken": "A String", # The standard List next-page token.
+  "operations": [ # A list of operations that matches the specified filter in the request.
+    { # 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.
+      },
+    },
+  ],
+  "unreachable": [ # 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.
+    "A String",
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html index 2b541419c4..2f55b47ca6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html @@ -238,7 +238,7 @@

Method Details

Args: parent: string, Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}` (required) filter: string, Optional. Filter expression restricting which AnalyzedSessions are returned. A subset of AIP-160 supporting two clauses joined by AND: 1. A closed time window on `detection_time`. If included, both bounds are required: detection_time >= "" AND detection_time <= "" 2. An equality on `severity`, where the value is the string representation of a Severity enum value (e.g., "CRITICAL", "HIGH", "MEDIUM", "LOW"). "SEVERITY_UNSPECIFIED" is not supported. The filter matches sessions whose maximum severity equals the requested bucket (a session whose detectors fire at LOW and CRITICAL is matched by `severity = "CRITICAL"`, not `severity = "LOW"`): severity = "CRITICAL" Both clauses are independently optional and may appear in either order. Each clause may appear at most once. Example (time window + severity): detection_time >= "2024-01-01T00:00:00Z" AND detection_time <= "2024-01-08T00:00:00Z" AND severity = "CRITICAL" If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (IN), and boolean combinations (OR, NOT, parentheses) are not yet supported. - orderBy: string, Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's "Detection time" header sorts on. Sorted by the underlying TIMESTAMP value (newer is "greater" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT. + orderBy: string, Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append " desc" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's "Detection time" header sorts on. Sorted by the underlying TIMESTAMP value (newer is "greater" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. * `agent_display_name` - the MonitoredAgent's display name as shown in the UI's "Agent name" column. Sorted as a STRING using BigQuery default collation (case-sensitive, code-point order). The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT. pageSize: integer, Optional. The maximum number of analyzed sessions to return. pageToken: string, Optional. A page token, received from a previous `ListAnalyzedSessions` call. view: string, Optional. Resource view to control which fields are returned. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html index fe74ec1b13..4be3d464b3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html @@ -207,13 +207,7 @@

Method Details

}, "createTime": "A String", # Output only. The time the MonitoredAgent was created. "displayName": "A String", # Optional. The display name of the MonitoredAgent. - "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}` - "A String", - ], "name": "A String", # Identifier. The resource name of the MonitoredAgent. - "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}` - "A String", - ], "state": "A String", # Output only. The current state of the agent's enablement. "statusMessage": "A String", # Output only. A brief message explaining the current state. "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated. @@ -247,13 +241,7 @@

Method Details

}, "createTime": "A String", # Output only. The time the MonitoredAgent was created. "displayName": "A String", # Optional. The display name of the MonitoredAgent. - "logBuckets": [ # Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}` - "A String", - ], "name": "A String", # Identifier. The resource name of the MonitoredAgent. - "observabilityBuckets": [ # Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}` - "A String", - ], "state": "A String", # Output only. The current state of the agent's enablement. "statusMessage": "A String", # Output only. A brief message explaining the current state. "updateTime": "A String", # Output only. The time the MonitoredAgent was last updated. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index aba532156f..a2405a6af2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -696,7 +696,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1067,7 +1068,14 @@

Method Details

An object of the form: { # This message contains configs of a publisher model. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. @@ -1554,7 +1562,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2309,7 +2318,14 @@

Method Details

{ # Request message for EndpointService.SetPublisherModelConfig. "publisherModelConfig": { # This message contains configs of a publisher model. # Required. The publisher model config. + "claudeFeatureConfig": { # Config for Claude-specific features. # Optional. Config for Claude-specific features. + "advancedAiEnabled": True or False, # Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read. + "cyberVerificationProgramEnabled": True or False, # Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813. + }, "dataSharingEnabledProvider": "A String", # Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected. + "inferenceEventLoggingConfig": { # Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log. # Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging. + "state": "A String", # Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled. + }, "loggingConfig": { # Configuration for logging request-response to a BigQuery table. # Optional. The prediction request/response logging config. "bigqueryDestination": { # The BigQuery location for the output content. # BigQuery table for logging. If only given a project, a new dataset will be created with name `logging__` where will be made BigQuery-dataset-name compatible (e.g. most special characters will become underscores). If no table name is given, a new table will be created with name `request_response_logging` "outputUri": "A String", # Required. BigQuery URI to a project or table, up to 2000 characters long. When only the project is specified, the Dataset and Table is created. When the full table reference is specified, the Dataset must exist and table must not exist. Accepted forms: * BigQuery path. For example: `bq://projectId` or `bq://projectId.bqDatasetId` or `bq://projectId.bqDatasetId.bqTableId`. @@ -2825,7 +2841,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 14f992020f..ff0ba9822e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -387,6 +387,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -473,6 +474,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -843,6 +847,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -929,6 +934,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1230,6 +1238,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1316,6 +1325,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1587,6 +1599,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1673,6 +1686,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index a80db69a68..47f5631b76 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -560,14 +560,30 @@

Method Details

}, ], }, + "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`. "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately. "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, + "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. + "a_key": { # Memory metadata. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. + }, + }, + "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. + "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html index 03a58cb7c7..3a725be8ff 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -168,6 +168,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -300,6 +303,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 2279ae3db9..701560e708 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -9668,6 +9668,8 @@

Method Details

"A String", ], }, + "inputBucketProjectNumber": "A String", # Optional. The project number of the project that the user expects to own the input Cloud Storage bucket referenced by gcs_source. The service verifies that the bucket is actually owned by this project before reading from it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent). + "outputBucketProjectNumber": "A String", # Optional. The project number of the project that the user expects to own the output Cloud Storage bucket referenced by gcs_destination. The service verifies that the bucket is actually owned by this project before writing to it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent). "veoSpec": { # Spec for Veo data processing. # Optional. Spec for Veo data processing. "processType": "A String", # Optional. The type of data processing to perform. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.operations.html index c4333d9702..37eeb60081 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.operations.html @@ -74,13 +74,40 @@

Agent Platform API . projects . locations . tuningJobs . operations

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+
close()
Close httplib2 connections.
@@ -104,4 +131,75 @@

Method Details

}
+
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 5504819090..042f1507af 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -676,7 +676,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1309,7 +1310,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -3506,7 +3508,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index cee0416f7c..785556ac2c 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -372,6 +372,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -458,6 +459,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -829,6 +833,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -915,6 +920,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1181,6 +1189,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1267,6 +1276,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. @@ -1538,6 +1550,7 @@

Method Details

"eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, "model": "A String", # Optional. The model used to generate memories. Format: `projects/{project}/locations/{location}/publishers/google/models/{model}`. @@ -1624,6 +1637,9 @@

Method Details

"a_key": "", # Properties of the object. }, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". + "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. + "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` + }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. { "a_key": "", # Properties of the object. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 52cbb8003a..57a6cd3b62 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -560,14 +560,30 @@

Method Details

}, ], }, + "disableMemoryRevisions": True or False, # Optional. If true, no revisions will be created for this request. "forceFlush": True or False, # Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`. "generationTriggerConfig": { # Represents configuration for triggering generation. # Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately. "generationRule": { # Represents the active rule that determines when to flush the buffer. # Optional. Represents the active rule that determines when to flush the buffer. If not set, then the stream will be force flushed immediately. "eventCount": 42, # Optional. Specifies to trigger generation when the event count reaches this limit. "fixedInterval": "A String", # Optional. Specifies to trigger generation at a fixed interval. The duration must have a minute-level granularity. "idleDuration": "A String", # Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. + "overlapEventCount": 42, # Optional. Re-include the last N already-processed events in the next window. }, }, + "metadata": { # Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. + "a_key": { # Memory metadata. + "boolValue": True or False, # Represents a boolean value. + "doubleValue": 3.14, # Represents a double value. + "stringValue": "A String", # Represents a string value. + "timestampValue": "A String", # Represents a timestamp value. When filtering on timestamp values, only the seconds field will be compared. + }, + }, + "metadataMergeStrategy": "A String", # Optional. The strategy to use when applying metadata to existing memories. + "revisionExpireTime": "A String", # Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + "revisionLabels": { # Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + "a_key": "A String", + }, + "revisionTtl": "A String", # Optional. The TTL for the revision. The expiration time is computed: now + TTL. "scope": { # Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, diff --git a/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html b/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html index 4675b59493..aed86c0c72 100644 --- a/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html +++ b/docs/dyn/aiplatform_v1beta1.tuningJobs.operations.html @@ -74,13 +74,40 @@

Agent Platform API . tuningJobs . operations

Instance Methods

+

+ cancel(name, x__xgafv=None)

+

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`.

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

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`.

+

+ get(name, x__xgafv=None)

+

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.

+

+ wait(name, timeout=None, x__xgafv=None)

+

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.

Method Details

+
+ cancel(name, x__xgafv=None) +
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`.
+
+Args:
+  name: string, The name of the operation resource to be cancelled. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+
close()
Close httplib2 connections.
@@ -104,4 +131,75 @@

Method Details

}
+
+ get(name, x__xgafv=None) +
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.
+
+Args:
+  name: string, The name of the operation resource. (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.
+  },
+}
+
+ +
+ wait(name, timeout=None, x__xgafv=None) +
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+  name: string, The name of the operation resource to wait on. (required)
+  timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 842cdb721f..7e5f79ea93 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -1127,7 +1127,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1454,7 +1455,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -1854,7 +1856,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2092,7 +2095,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2422,7 +2426,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -2660,7 +2665,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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. @@ -4964,7 +4970,8 @@

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. + "enableDataRetention": True or False, # Optional. Deprecated: Use `enable_zero_data_retention` instead. 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. + "enableZeroDataRetention": 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/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index aae12d885f..aad338ba3b 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -4024,17 +4024,17 @@ } } }, -"metadataStores": { +"memoryBanks": { "resources": { -"artifacts": { +"memories": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", +"flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.artifacts.operations.cancel", +"id": "aiplatform.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -4042,7 +4042,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4057,9 +4057,9 @@ }, "delete": { "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`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", +"flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.artifacts.operations.delete", +"id": "aiplatform.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -4067,7 +4067,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4082,9 +4082,9 @@ }, "get": { "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": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", +"flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.artifacts.operations.get", +"id": "aiplatform.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -4092,7 +4092,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4107,9 +4107,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", +"flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.artifacts.operations.list", +"id": "aiplatform.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -4122,7 +4122,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, @@ -4153,9 +4153,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", +"flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.artifacts.operations.wait", +"id": "aiplatform.memoryBanks.memories.operations.wait", "parameterOrder": [ "name" ], @@ -4163,7 +4163,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4186,15 +4186,13 @@ } } }, -"contexts": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", +"flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.contexts.operations.cancel", +"id": "aiplatform.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -4202,7 +4200,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4217,9 +4215,9 @@ }, "delete": { "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`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", +"flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.contexts.operations.delete", +"id": "aiplatform.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -4227,7 +4225,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4242,9 +4240,9 @@ }, "get": { "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": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", +"flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.contexts.operations.get", +"id": "aiplatform.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -4252,7 +4250,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4267,9 +4265,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", +"flatPath": "v1/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.contexts.operations.list", +"id": "aiplatform.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -4282,7 +4280,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+$", +"pattern": "^memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -4313,9 +4311,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", +"flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.contexts.operations.wait", +"id": "aiplatform.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -4323,7 +4321,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4346,15 +4344,17 @@ } } }, -"executions": { +"metadataStores": { +"resources": { +"artifacts": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", +"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.executions.operations.cancel", +"id": "aiplatform.metadataStores.artifacts.operations.cancel", "parameterOrder": [ "name" ], @@ -4362,7 +4362,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4377,9 +4377,9 @@ }, "delete": { "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`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.executions.operations.delete", +"id": "aiplatform.metadataStores.artifacts.operations.delete", "parameterOrder": [ "name" ], @@ -4387,7 +4387,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4402,9 +4402,9 @@ }, "get": { "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": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.executions.operations.get", +"id": "aiplatform.metadataStores.artifacts.operations.get", "parameterOrder": [ "name" ], @@ -4412,7 +4412,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4427,9 +4427,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", +"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.executions.operations.list", +"id": "aiplatform.metadataStores.artifacts.operations.list", "parameterOrder": [ "name" ], @@ -4442,7 +4442,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, @@ -4473,9 +4473,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", +"flatPath": "v1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.executions.operations.wait", +"id": "aiplatform.metadataStores.artifacts.operations.wait", "parameterOrder": [ "name" ], @@ -4483,7 +4483,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4506,13 +4506,15 @@ } } }, +"contexts": { +"resources": { "operations": { "methods": { "cancel": { "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": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", +"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.operations.cancel", +"id": "aiplatform.metadataStores.contexts.operations.cancel", "parameterOrder": [ "name" ], @@ -4520,7 +4522,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4535,9 +4537,9 @@ }, "delete": { "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`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.operations.delete", +"id": "aiplatform.metadataStores.contexts.operations.delete", "parameterOrder": [ "name" ], @@ -4545,7 +4547,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4560,9 +4562,9 @@ }, "get": { "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": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.operations.get", +"id": "aiplatform.metadataStores.contexts.operations.get", "parameterOrder": [ "name" ], @@ -4570,7 +4572,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4585,9 +4587,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/metadataStores/{metadataStoresId}/operations", +"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.operations.list", +"id": "aiplatform.metadataStores.contexts.operations.list", "parameterOrder": [ "name" ], @@ -4600,7 +4602,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" }, @@ -4631,9 +4633,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", +"flatPath": "v1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.operations.wait", +"id": "aiplatform.metadataStores.contexts.operations.wait", "parameterOrder": [ "name" ], @@ -4641,7 +4643,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4664,15 +4666,15 @@ } } }, -"migratableResources": { +"executions": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", +"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.migratableResources.operations.cancel", +"id": "aiplatform.metadataStores.executions.operations.cancel", "parameterOrder": [ "name" ], @@ -4680,7 +4682,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4695,9 +4697,9 @@ }, "delete": { "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`.", -"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.migratableResources.operations.delete", +"id": "aiplatform.metadataStores.executions.operations.delete", "parameterOrder": [ "name" ], @@ -4705,7 +4707,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4720,9 +4722,9 @@ }, "get": { "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": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.migratableResources.operations.get", +"id": "aiplatform.metadataStores.executions.operations.get", "parameterOrder": [ "name" ], @@ -4730,7 +4732,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4745,9 +4747,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/migratableResources/{migratableResourcesId}/operations", +"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.migratableResources.operations.list", +"id": "aiplatform.metadataStores.executions.operations.list", "parameterOrder": [ "name" ], @@ -4760,7 +4762,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^migratableResources/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, @@ -4791,9 +4793,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", +"flatPath": "v1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.migratableResources.operations.wait", +"id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ], @@ -4801,7 +4803,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4824,15 +4826,13 @@ } } }, -"modelDeploymentMonitoringJobs": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", +"id": "aiplatform.metadataStores.operations.cancel", "parameterOrder": [ "name" ], @@ -4840,7 +4840,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4855,9 +4855,9 @@ }, "delete": { "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`.", -"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", +"id": "aiplatform.metadataStores.operations.delete", "parameterOrder": [ "name" ], @@ -4865,7 +4865,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4880,9 +4880,9 @@ }, "get": { "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": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", +"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", +"id": "aiplatform.metadataStores.operations.get", "parameterOrder": [ "name" ], @@ -4890,7 +4890,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -4905,9 +4905,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", +"flatPath": "v1/metadataStores/{metadataStoresId}/operations", "httpMethod": "GET", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", +"id": "aiplatform.metadataStores.operations.list", "parameterOrder": [ "name" ], @@ -4920,7 +4920,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+$", +"pattern": "^metadataStores/[^/]+$", "required": true, "type": "string" }, @@ -4951,9 +4951,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", +"flatPath": "v1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", +"id": "aiplatform.metadataStores.operations.wait", "parameterOrder": [ "name" ], @@ -4961,7 +4961,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -4984,17 +4984,15 @@ } } }, -"models": { -"resources": { -"evaluations": { +"migratableResources": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", +"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.models.evaluations.operations.cancel", +"id": "aiplatform.migratableResources.operations.cancel", "parameterOrder": [ "name" ], @@ -5002,7 +5000,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5017,9 +5015,9 @@ }, "delete": { "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`.", -"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", +"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.models.evaluations.operations.delete", +"id": "aiplatform.migratableResources.operations.delete", "parameterOrder": [ "name" ], @@ -5027,7 +5025,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5042,9 +5040,9 @@ }, "get": { "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": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", +"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.models.evaluations.operations.get", +"id": "aiplatform.migratableResources.operations.get", "parameterOrder": [ "name" ], @@ -5052,7 +5050,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5067,9 +5065,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations", +"flatPath": "v1/migratableResources/{migratableResourcesId}/operations", "httpMethod": "GET", -"id": "aiplatform.models.evaluations.operations.list", +"id": "aiplatform.migratableResources.operations.list", "parameterOrder": [ "name" ], @@ -5082,7 +5080,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+$", +"pattern": "^migratableResources/[^/]+$", "required": true, "type": "string" }, @@ -5113,9 +5111,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", +"flatPath": "v1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.models.evaluations.operations.wait", +"id": "aiplatform.migratableResources.operations.wait", "parameterOrder": [ "name" ], @@ -5123,7 +5121,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5146,13 +5144,15 @@ } } }, +"modelDeploymentMonitoringJobs": { +"resources": { "operations": { "methods": { "cancel": { "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": "v1/models/{modelsId}/operations/{operationsId}:cancel", +"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.models.operations.cancel", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -5160,7 +5160,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5175,9 +5175,9 @@ }, "delete": { "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`.", -"flatPath": "v1/models/{modelsId}/operations/{operationsId}", +"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.models.operations.delete", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", "parameterOrder": [ "name" ], @@ -5185,7 +5185,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5200,9 +5200,9 @@ }, "get": { "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": "v1/models/{modelsId}/operations/{operationsId}", +"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.models.operations.get", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", "parameterOrder": [ "name" ], @@ -5210,7 +5210,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5225,9 +5225,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/models/{modelsId}/operations", +"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "httpMethod": "GET", -"id": "aiplatform.models.operations.list", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", "parameterOrder": [ "name" ], @@ -5240,7 +5240,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^models/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, @@ -5271,9 +5271,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/models/{modelsId}/operations/{operationsId}:wait", +"flatPath": "v1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.models.operations.wait", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", "parameterOrder": [ "name" ], @@ -5281,7 +5281,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5304,15 +5304,17 @@ } } }, -"notebookExecutionJobs": { +"models": { +"resources": { +"evaluations": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookExecutionJobs.operations.cancel", +"id": "aiplatform.models.evaluations.operations.cancel", "parameterOrder": [ "name" ], @@ -5320,7 +5322,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5335,9 +5337,9 @@ }, "delete": { "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`.", -"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", +"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookExecutionJobs.operations.delete", +"id": "aiplatform.models.evaluations.operations.delete", "parameterOrder": [ "name" ], @@ -5345,7 +5347,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5360,9 +5362,9 @@ }, "get": { "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": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", +"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookExecutionJobs.operations.get", +"id": "aiplatform.models.evaluations.operations.get", "parameterOrder": [ "name" ], @@ -5370,7 +5372,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5385,9 +5387,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", +"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookExecutionJobs.operations.list", +"id": "aiplatform.models.evaluations.operations.list", "parameterOrder": [ "name" ], @@ -5400,7 +5402,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" }, @@ -5431,9 +5433,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", +"flatPath": "v1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookExecutionJobs.operations.wait", +"id": "aiplatform.models.evaluations.operations.wait", "parameterOrder": [ "name" ], @@ -5441,7 +5443,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5464,15 +5466,13 @@ } } }, -"notebookRuntimeTemplates": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", +"flatPath": "v1/models/{modelsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimeTemplates.operations.cancel", +"id": "aiplatform.models.operations.cancel", "parameterOrder": [ "name" ], @@ -5480,7 +5480,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5495,9 +5495,9 @@ }, "delete": { "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`.", -"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", +"flatPath": "v1/models/{modelsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookRuntimeTemplates.operations.delete", +"id": "aiplatform.models.operations.delete", "parameterOrder": [ "name" ], @@ -5505,7 +5505,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5520,9 +5520,9 @@ }, "get": { "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": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", +"flatPath": "v1/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimeTemplates.operations.get", +"id": "aiplatform.models.operations.get", "parameterOrder": [ "name" ], @@ -5530,7 +5530,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5545,9 +5545,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", +"flatPath": "v1/models/{modelsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimeTemplates.operations.list", +"id": "aiplatform.models.operations.list", "parameterOrder": [ "name" ], @@ -5560,7 +5560,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+$", +"pattern": "^models/[^/]+$", "required": true, "type": "string" }, @@ -5591,9 +5591,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", +"flatPath": "v1/models/{modelsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimeTemplates.operations.wait", +"id": "aiplatform.models.operations.wait", "parameterOrder": [ "name" ], @@ -5601,7 +5601,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5624,15 +5624,15 @@ } } }, -"notebookRuntimes": { +"notebookExecutionJobs": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", +"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimes.operations.cancel", +"id": "aiplatform.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -5640,7 +5640,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5655,9 +5655,9 @@ }, "delete": { "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`.", -"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookRuntimes.operations.delete", +"id": "aiplatform.notebookExecutionJobs.operations.delete", "parameterOrder": [ "name" ], @@ -5665,7 +5665,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5680,9 +5680,9 @@ }, "get": { "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": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimes.operations.get", +"id": "aiplatform.notebookExecutionJobs.operations.get", "parameterOrder": [ "name" ], @@ -5690,7 +5690,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5705,9 +5705,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations", +"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimes.operations.list", +"id": "aiplatform.notebookExecutionJobs.operations.list", "parameterOrder": [ "name" ], @@ -5720,7 +5720,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+$", "required": true, "type": "string" }, @@ -5751,9 +5751,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", +"flatPath": "v1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimes.operations.wait", +"id": "aiplatform.notebookExecutionJobs.operations.wait", "parameterOrder": [ "name" ], @@ -5761,7 +5761,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5784,15 +5784,15 @@ } } }, -"onlineEvaluators": { +"notebookRuntimeTemplates": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.onlineEvaluators.operations.cancel", +"id": "aiplatform.notebookRuntimeTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -5800,7 +5800,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5815,9 +5815,9 @@ }, "delete": { "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`.", -"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.onlineEvaluators.operations.delete", +"id": "aiplatform.notebookRuntimeTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -5825,7 +5825,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5840,9 +5840,9 @@ }, "get": { "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": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.onlineEvaluators.operations.get", +"id": "aiplatform.notebookRuntimeTemplates.operations.get", "parameterOrder": [ "name" ], @@ -5850,7 +5850,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5865,9 +5865,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations", +"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", -"id": "aiplatform.onlineEvaluators.operations.list", +"id": "aiplatform.notebookRuntimeTemplates.operations.list", "parameterOrder": [ "name" ], @@ -5880,7 +5880,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, @@ -5911,9 +5911,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"flatPath": "v1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.onlineEvaluators.operations.wait", +"id": "aiplatform.notebookRuntimeTemplates.operations.wait", "parameterOrder": [ "name" ], @@ -5921,7 +5921,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -5944,167 +5944,15 @@ } } }, -"operations": { -"methods": { -"cancel": { -"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": "v1/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"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`.", -"flatPath": "v1/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"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": "v1/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/operations", -"httpMethod": "GET", -"id": "aiplatform.operations.list", -"parameterOrder": [], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"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.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"persistentResources": { +"notebookRuntimes": { "resources": { "operations": { "methods": { "cancel": { "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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", +"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.persistentResources.operations.cancel", +"id": "aiplatform.notebookRuntimes.operations.cancel", "parameterOrder": [ "name" ], @@ -6112,7 +5960,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6127,9 +5975,9 @@ }, "delete": { "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`.", -"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.persistentResources.operations.delete", +"id": "aiplatform.notebookRuntimes.operations.delete", "parameterOrder": [ "name" ], @@ -6137,7 +5985,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6152,9 +6000,9 @@ }, "get": { "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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.persistentResources.operations.get", +"id": "aiplatform.notebookRuntimes.operations.get", "parameterOrder": [ "name" ], @@ -6162,7 +6010,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6177,9 +6025,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/persistentResources/{persistentResourcesId}/operations", +"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations", "httpMethod": "GET", -"id": "aiplatform.persistentResources.operations.list", +"id": "aiplatform.notebookRuntimes.operations.list", "parameterOrder": [ "name" ], @@ -6192,7 +6040,479 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^persistentResources/[^/]+$", +"pattern": "^notebookRuntimes/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.notebookRuntimes.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"onlineEvaluators": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.onlineEvaluators.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"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": "v1/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/operations", +"httpMethod": "GET", +"id": "aiplatform.operations.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"persistentResources": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.persistentResources.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.persistentResources.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.persistentResources.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/persistentResources/{persistentResourcesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.persistentResources.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^persistentResources/[^/]+$", "required": true, "type": "string" }, @@ -11299,6 +11619,139 @@ } } }, +"evaluationMetrics": { +"methods": { +"create": { +"description": "Creates an EvaluationMetric.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.evaluationMetrics.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"evaluationMetricId": { +"description": "Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationMetrics", +"request": { +"$ref": "GoogleCloudAiplatformV1EvaluationMetric" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationMetric" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an EvaluationMetric.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.evaluationMetrics.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an EvaluationMetric.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationMetrics.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the EvaluationMetric resource. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1EvaluationMetric" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists EvaluationMetrics.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.evaluationMetrics.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of EvaluationMetrics to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/evaluationMetrics", +"response": { +"$ref": "GoogleCloudAiplatformV1ListEvaluationMetricsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "evaluationRuns": { "methods": { "cancel": { @@ -15582,9 +16035,575 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexEndpoints.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"indexes": { +"methods": { +"create": { +"description": "Creates an Index.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/indexes", +"request": { +"$ref": "GoogleCloudAiplatformV1Index" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.indexes.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Index.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1Index" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Indexes in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/indexes", +"response": { +"$ref": "GoogleCloudAiplatformV1ListIndexesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an Index.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.indexes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The resource name of the Index.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1Index" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeDatapoints": { +"description": "Remove Datapoints from an Index.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.removeDatapoints", +"parameterOrder": [ +"index" +], +"parameters": { +"index": { +"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+index}:removeDatapoints", +"request": { +"$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"upsertDatapoints": { +"description": "Add/update Datapoints into an Index.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.upsertDatapoints", +"parameterOrder": [ +"index" +], +"parameters": { +"index": { +"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+index}:upsertDatapoints", +"request": { +"$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.indexes.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"memoryBanks": { +"resources": { +"memories": { +"methods": { +"get": { +"description": "Get a Memory.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1Memory" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexEndpoints.operations.wait", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", "parameterOrder": [ "name" ], @@ -15592,7 +16611,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -15615,232 +16634,13 @@ } } }, -"indexes": { -"methods": { -"create": { -"description": "Creates an Index.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/indexes", -"request": { -"$ref": "GoogleCloudAiplatformV1Index" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.indexes.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets an Index.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1Index" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists Indexes in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/indexes", -"response": { -"$ref": "GoogleCloudAiplatformV1ListIndexesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates an Index.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.indexes.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The resource name of the Index.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1Index" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"removeDatapoints": { -"description": "Remove Datapoints from an Index.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.removeDatapoints", -"parameterOrder": [ -"index" -], -"parameters": { -"index": { -"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+index}:removeDatapoints", -"request": { -"$ref": "GoogleCloudAiplatformV1RemoveDatapointsRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1RemoveDatapointsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"upsertDatapoints": { -"description": "Add/update Datapoints into an Index.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.upsertDatapoints", -"parameterOrder": [ -"index" -], -"parameters": { -"index": { -"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+index}:upsertDatapoints", -"request": { -"$ref": "GoogleCloudAiplatformV1UpsertDatapointsRequest" -}, -"response": { -"$ref": "GoogleCloudAiplatformV1UpsertDatapointsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { "operations": { "methods": { "cancel": { "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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -15848,7 +16648,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15863,9 +16663,9 @@ }, "delete": { "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`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.indexes.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -15873,7 +16673,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15888,9 +16688,9 @@ }, "get": { "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": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -15898,7 +16698,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15913,9 +16713,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -15928,7 +16728,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -15959,9 +16759,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.operations.wait", +"id": "aiplatform.projects.locations.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -15969,7 +16769,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -29521,6 +30321,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -33781,6 +34612,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.tuningJobs.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -33845,7 +34707,7 @@ } } }, -"revision": "20260623", +"revision": "20260703", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -34713,6 +35575,62 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1AgentData": { +"description": "Represents data specific to multi-turn agent evaluations.", +"id": "GoogleCloudAiplatformV1AgentData", +"properties": { +"agents": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1AgentConfig" +}, +"description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", +"type": "object" +}, +"turns": { +"description": "Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).", +"items": { +"$ref": "GoogleCloudAiplatformV1ConversationTurn" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1AgentEvent": { +"description": "Represents a single event in the execution trace.", +"id": "GoogleCloudAiplatformV1AgentEvent", +"properties": { +"activeTools": { +"description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" +}, +"author": { +"description": "Required. The ID of the agent or entity that generated this event. Use \"user\" to denote events generated by the end-user.", +"type": "string" +}, +"content": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "Required. The content of the event (e.g., text response, tool call, tool response)." +}, +"eventTime": { +"description": "Optional. The timestamp when the event occurred.", +"format": "google-datetime", +"type": "string" +}, +"stateDelta": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1AgentTool": { "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "id": "GoogleCloudAiplatformV1AgentTool", @@ -36616,6 +37534,10 @@ "description": "Responses from model or agent.", "id": "GoogleCloudAiplatformV1CandidateResponse", "properties": { +"agentData": { +"$ref": "GoogleCloudAiplatformV1AgentData", +"description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation." +}, "candidate": { "description": "Required. The name of the candidate that produced the response.", "type": "string" @@ -36648,6 +37570,11 @@ "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", "type": "string" }, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Error while evaluating the candidate for the metric.", +"readOnly": true +}, "explanation": { "description": "Optional. The explanation for the metric.", "type": "string" @@ -36844,6 +37771,51 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CloudLoggingConfig": { +"description": "Specifies configuration for exporting evaluation results to Cloud Logging.", +"id": "GoogleCloudAiplatformV1CloudLoggingConfig", +"properties": { +"project": { +"description": "Optional. Google Cloud project to write logs to. Defaults to the request project.", +"type": "string" +}, +"resourceLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location.", +"type": "object" +}, +"resourceType": { +"description": "Optional. MonitoredResource type. Defaults to \"global\" if unspecified.", +"type": "string" +}, +"tracingContext": { +"$ref": "GoogleCloudAiplatformV1CloudLoggingConfigTracingContext", +"description": "Optional. Tracing context for the evaluation run." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1CloudLoggingConfigTracingContext": { +"description": "Tracing context for Observability correlation.", +"id": "GoogleCloudAiplatformV1CloudLoggingConfigTracingContext", +"properties": { +"conversationId": { +"description": "Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes.", +"type": "string" +}, +"spanId": { +"description": "Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated.", +"type": "string" +}, +"traceId": { +"description": "Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CodeExecutionResult": { "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1CodeExecutionResult", @@ -37298,6 +38270,29 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ConversationTurn": { +"description": "Represents a single turn/invocation in the conversation.", +"id": "GoogleCloudAiplatformV1ConversationTurn", +"properties": { +"events": { +"description": "Optional. The list of events that occurred during this turn.", +"items": { +"$ref": "GoogleCloudAiplatformV1AgentEvent" +}, +"type": "array" +}, +"turnId": { +"description": "Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.", +"type": "string" +}, +"turnIndex": { +"description": "Required. The 0-based index of the turn in the conversation sequence.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CopyModelOperationMetadata": { "description": "Details of ModelService.CopyModel operation.", "id": "GoogleCloudAiplatformV1CopyModelOperationMetadata", @@ -40811,6 +41806,52 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationMetric": { +"description": "EvaluationMetric is a resource that represents a reusable metric configuration.", +"id": "GoogleCloudAiplatformV1EvaluationMetric", +"properties": { +"createTime": { +"description": "Output only. The time when the EvaluationMetric was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A description of the EvaluationMetric.", +"type": "string" +}, +"displayName": { +"description": "Required. The user-friendly display name for the EvaluationMetric.", +"type": "string" +}, +"gcsUri": { +"description": "Optional. The Google Cloud Storage URI that stores the metric specification..", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels for the evaluation metric.", +"type": "object" +}, +"metric": { +"$ref": "GoogleCloudAiplatformV1Metric", +"description": "Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported." +}, +"name": { +"description": "Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the EvaluationMetric was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluationParserConfig": { "description": "Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters.", "id": "GoogleCloudAiplatformV1EvaluationParserConfig", @@ -40837,6 +41878,10 @@ "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", "id": "GoogleCloudAiplatformV1EvaluationPrompt", "properties": { +"agentData": { +"$ref": "GoogleCloudAiplatformV1AgentData", +"description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping." +}, "promptTemplateData": { "$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", "description": "Prompt template data." @@ -40845,6 +41890,10 @@ "description": "Text prompt.", "type": "string" }, +"userScenario": { +"$ref": "GoogleCloudAiplatformV1EvaluationPromptUserScenario", +"description": "Optional. The generated user scenario used to drive multi-turn agent running results." +}, "value": { "description": "Fields and values that can be used to populate the prompt template.", "type": "any" @@ -40866,6 +41915,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1EvaluationPromptUserScenario": { +"description": "User scenario to help simulate multi-turn agent running results.", +"id": "GoogleCloudAiplatformV1EvaluationPromptUserScenario", +"properties": { +"conversationPlan": { +"description": "Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset.", +"type": "string" +}, +"startingPrompt": { +"description": "Required. The prompt that starts the conversation between the simulated user and the agent under test.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1EvaluationRequest": { "description": "A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`.", "id": "GoogleCloudAiplatformV1EvaluationRequest", @@ -41081,6 +42145,10 @@ "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, +"cloudLoggingConfig": { +"$ref": "GoogleCloudAiplatformV1CloudLoggingConfig", +"description": "Optional. Configuration for exporting evaluation results to Cloud Logging." +}, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "items": { @@ -41088,6 +42156,13 @@ }, "type": "array" }, +"lossAnalysisConfig": { +"description": "Optional. Specifications for loss analysis. Each config can be specified for one metric.", +"items": { +"$ref": "GoogleCloudAiplatformV1LossAnalysisConfig" +}, +"type": "array" +}, "metrics": { "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set.", "items": { @@ -41171,6 +42246,13 @@ "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig", "description": "Optional. Agent run config." }, +"agents": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1AgentConfig" +}, +"description": "Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", +"type": "object" +}, "generationConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfig", "description": "Optional. Generation config." @@ -41183,6 +42265,10 @@ "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", "format": "int32", "type": "integer" +}, +"promptTemplate": { +"$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", +"description": "Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used." } }, "type": "object" @@ -45376,7 +46462,7 @@ "additionalProperties": { "$ref": "GoogleCloudAiplatformV1AgentConfig" }, -"description": "Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", +"description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent.", "type": "object" }, "allowCrossRegionModel": { @@ -45384,7 +46470,7 @@ "type": "boolean" }, "rootAgentId": { -"description": "Required. The agent id to identify the root agent.", +"description": "Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent.", "type": "string" }, "userScenarioGenerationConfig": { @@ -47260,6 +48346,10 @@ "$ref": "GoogleCloudAiplatformV1IngestionDirectContentsSource", "description": "Ingest events directly from the request." }, +"disableMemoryRevisions": { +"description": "Optional. If true, no revisions will be created for this request.", +"type": "boolean" +}, "forceFlush": { "description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", "type": "boolean" @@ -47268,6 +48358,46 @@ "$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", "description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately." }, +"metadata": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" +}, +"description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", +"type": "object" +}, +"metadataMergeStrategy": { +"description": "Optional. The strategy to use when applying metadata to existing memories.", +"enum": [ +"METADATA_MERGE_STRATEGY_UNSPECIFIED", +"OVERWRITE", +"MERGE", +"REQUIRE_EXACT_MATCH" +], +"enumDescriptions": [ +"Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", +"Replace the metadata of the updated memories with the new metadata.", +"Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", +"Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." +], +"type": "string" +}, +"revisionExpireTime": { +"description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", +"format": "google-datetime", +"type": "string" +}, +"revisionLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", +"type": "object" +}, +"revisionTtl": { +"description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", +"format": "google-duration", +"type": "string" +}, "scope": { "additionalProperties": { "type": "string" @@ -47878,6 +49008,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListEvaluationMetricsResponse": { +"description": "Response message for EvaluationMetricService.ListEvaluationMetrics.", +"id": "GoogleCloudAiplatformV1ListEvaluationMetricsResponse", +"properties": { +"evaluationMetrics": { +"description": "List of EvaluationMetrics in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1EvaluationMetric" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListEvaluationRunsResponse": { "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", "id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", @@ -49387,6 +50535,11 @@ false "description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", "format": "google-duration", "type": "string" +}, +"overlapEventCount": { +"description": "Optional. Re-include the last N already-processed events in the next window.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -56782,6 +57935,10 @@ false "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, +"buildSpec": { +"$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", +"description": "Optional. Configuration for building container image." +}, "classMethods": { "description": "Optional. Declarations for object class methods in OpenAPI specification format.", "items": { @@ -56835,6 +57992,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec": { +"description": "Specification for building container image.", +"id": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", +"properties": { +"workerPool": { +"description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec": { "description": "Specification for deploying from a container image.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec", @@ -66300,6 +67468,11 @@ false "type": "object" }, "enableDataRetention": { +"deprecated": true, +"description": "Optional. Deprecated: Use `enable_zero_data_retention` instead. 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.", +"type": "boolean" +}, +"enableZeroDataRetention": { "description": "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.", "type": "boolean" } diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 84b315e18c..b12747c318 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -5875,177 +5875,44 @@ } } }, -"metadataStores": { -"resources": { -"artifacts": { +"memoryBanks": { "resources": { -"operations": { +"memories": { "methods": { -"cancel": { -"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": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.metadataStores.artifacts.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"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`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.metadataStores.artifacts.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "get": { -"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": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", +"description": "Get a Memory.", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.artifacts.operations.get", +"id": "aiplatform.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", -"httpMethod": "GET", -"id": "aiplatform.metadataStores.artifacts.operations.list", -"parameterOrder": [ -"name" -], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", -"required": true, -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"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.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.metadataStores.artifacts.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAiplatformV1beta1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, -"contexts": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.contexts.operations.cancel", +"id": "aiplatform.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -6053,7 +5920,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6068,9 +5935,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.contexts.operations.delete", +"id": "aiplatform.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -6078,7 +5945,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6093,9 +5960,9 @@ }, "get": { "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": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.contexts.operations.get", +"id": "aiplatform.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -6103,7 +5970,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6118,9 +5985,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.contexts.operations.list", +"id": "aiplatform.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -6133,7 +6000,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, @@ -6164,9 +6031,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.contexts.operations.wait", +"id": "aiplatform.memoryBanks.memories.operations.wait", "parameterOrder": [ "name" ], @@ -6174,7 +6041,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6197,15 +6064,13 @@ } } }, -"executions": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.executions.operations.cancel", +"id": "aiplatform.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -6213,7 +6078,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6228,9 +6093,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.executions.operations.delete", +"id": "aiplatform.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -6238,7 +6103,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6253,9 +6118,9 @@ }, "get": { "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": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.executions.operations.get", +"id": "aiplatform.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -6263,7 +6128,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6278,9 +6143,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.executions.operations.list", +"id": "aiplatform.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -6293,7 +6158,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+$", +"pattern": "^memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -6324,9 +6189,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.executions.operations.wait", +"id": "aiplatform.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -6334,7 +6199,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", +"pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6357,13 +6222,17 @@ } } }, +"metadataStores": { +"resources": { +"artifacts": { +"resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.metadataStores.operations.cancel", +"id": "aiplatform.metadataStores.artifacts.operations.cancel", "parameterOrder": [ "name" ], @@ -6371,7 +6240,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6386,9 +6255,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.metadataStores.operations.delete", +"id": "aiplatform.metadataStores.artifacts.operations.delete", "parameterOrder": [ "name" ], @@ -6396,7 +6265,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6411,9 +6280,9 @@ }, "get": { "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": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.metadataStores.operations.get", +"id": "aiplatform.metadataStores.artifacts.operations.get", "parameterOrder": [ "name" ], @@ -6421,7 +6290,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6436,9 +6305,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", "httpMethod": "GET", -"id": "aiplatform.metadataStores.operations.list", +"id": "aiplatform.metadataStores.artifacts.operations.list", "parameterOrder": [ "name" ], @@ -6451,7 +6320,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^metadataStores/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, @@ -6482,9 +6351,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.metadataStores.operations.wait", +"id": "aiplatform.metadataStores.artifacts.operations.wait", "parameterOrder": [ "name" ], @@ -6492,7 +6361,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^metadataStores/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6515,15 +6384,15 @@ } } }, -"migratableResources": { +"contexts": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.migratableResources.operations.cancel", +"id": "aiplatform.metadataStores.contexts.operations.cancel", "parameterOrder": [ "name" ], @@ -6531,7 +6400,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6546,9 +6415,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.migratableResources.operations.delete", +"id": "aiplatform.metadataStores.contexts.operations.delete", "parameterOrder": [ "name" ], @@ -6556,7 +6425,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6571,9 +6440,9 @@ }, "get": { "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": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.migratableResources.operations.get", +"id": "aiplatform.metadataStores.contexts.operations.get", "parameterOrder": [ "name" ], @@ -6581,7 +6450,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6596,9 +6465,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", "httpMethod": "GET", -"id": "aiplatform.migratableResources.operations.list", +"id": "aiplatform.metadataStores.contexts.operations.list", "parameterOrder": [ "name" ], @@ -6611,7 +6480,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^migratableResources/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+$", "required": true, "type": "string" }, @@ -6642,9 +6511,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.migratableResources.operations.wait", +"id": "aiplatform.metadataStores.contexts.operations.wait", "parameterOrder": [ "name" ], @@ -6652,7 +6521,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^migratableResources/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6675,15 +6544,15 @@ } } }, -"modelDeploymentMonitoringJobs": { +"executions": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", +"id": "aiplatform.metadataStores.executions.operations.cancel", "parameterOrder": [ "name" ], @@ -6691,7 +6560,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6706,9 +6575,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", +"id": "aiplatform.metadataStores.executions.operations.delete", "parameterOrder": [ "name" ], @@ -6716,7 +6585,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6731,9 +6600,9 @@ }, "get": { "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": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", +"id": "aiplatform.metadataStores.executions.operations.get", "parameterOrder": [ "name" ], @@ -6741,7 +6610,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6756,9 +6625,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", +"id": "aiplatform.metadataStores.executions.operations.list", "parameterOrder": [ "name" ], @@ -6771,7 +6640,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, @@ -6802,9 +6671,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", +"id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ], @@ -6812,7 +6681,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6835,15 +6704,13 @@ } } }, -"modelMonitors": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.modelMonitors.operations.cancel", +"id": "aiplatform.metadataStores.operations.cancel", "parameterOrder": [ "name" ], @@ -6851,7 +6718,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6866,9 +6733,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.modelMonitors.operations.delete", +"id": "aiplatform.metadataStores.operations.delete", "parameterOrder": [ "name" ], @@ -6876,7 +6743,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6891,9 +6758,9 @@ }, "get": { "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": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.modelMonitors.operations.get", +"id": "aiplatform.metadataStores.operations.get", "parameterOrder": [ "name" ], @@ -6901,7 +6768,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6916,9 +6783,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", "httpMethod": "GET", -"id": "aiplatform.modelMonitors.operations.list", +"id": "aiplatform.metadataStores.operations.list", "parameterOrder": [ "name" ], @@ -6931,7 +6798,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^modelMonitors/[^/]+$", +"pattern": "^metadataStores/[^/]+$", "required": true, "type": "string" }, @@ -6962,9 +6829,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.modelMonitors.operations.wait", +"id": "aiplatform.metadataStores.operations.wait", "parameterOrder": [ "name" ], @@ -6972,7 +6839,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", +"pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6995,175 +6862,15 @@ } } }, -"models": { -"resources": { -"evaluations": { +"migratableResources": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.models.evaluations.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"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`.", -"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.models.evaluations.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"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": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.models.evaluations.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", -"location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", -"httpMethod": "GET", -"id": "aiplatform.models.evaluations.operations.list", -"parameterOrder": [ -"name" -], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+$", -"required": true, -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"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.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/{+name}/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.models.evaluations.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, -"operations": { -"methods": { -"cancel": { -"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": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.models.operations.cancel", +"id": "aiplatform.migratableResources.operations.cancel", "parameterOrder": [ "name" ], @@ -7171,7 +6878,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7186,9 +6893,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", +"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.models.operations.delete", +"id": "aiplatform.migratableResources.operations.delete", "parameterOrder": [ "name" ], @@ -7196,7 +6903,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7211,9 +6918,9 @@ }, "get": { "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": "v1beta1/models/{modelsId}/operations/{operationsId}", +"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.models.operations.get", +"id": "aiplatform.migratableResources.operations.get", "parameterOrder": [ "name" ], @@ -7221,7 +6928,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7236,9 +6943,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/models/{modelsId}/operations", +"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations", "httpMethod": "GET", -"id": "aiplatform.models.operations.list", +"id": "aiplatform.migratableResources.operations.list", "parameterOrder": [ "name" ], @@ -7251,7 +6958,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^models/[^/]+$", +"pattern": "^migratableResources/[^/]+$", "required": true, "type": "string" }, @@ -7282,9 +6989,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.models.operations.wait", +"id": "aiplatform.migratableResources.operations.wait", "parameterOrder": [ "name" ], @@ -7292,7 +6999,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^models/[^/]+/operations/[^/]+$", +"pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7315,15 +7022,15 @@ } } }, -"notebookExecutionJobs": { +"modelDeploymentMonitoringJobs": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookExecutionJobs.operations.cancel", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -7331,7 +7038,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7346,9 +7053,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookExecutionJobs.operations.delete", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", "parameterOrder": [ "name" ], @@ -7356,7 +7063,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7371,9 +7078,9 @@ }, "get": { "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": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookExecutionJobs.operations.get", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", "parameterOrder": [ "name" ], @@ -7381,7 +7088,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7396,9 +7103,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", +"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookExecutionJobs.operations.list", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", "parameterOrder": [ "name" ], @@ -7411,7 +7118,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, @@ -7442,9 +7149,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookExecutionJobs.operations.wait", +"id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", "parameterOrder": [ "name" ], @@ -7452,7 +7159,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", +"pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7475,15 +7182,15 @@ } } }, -"notebookRuntimeTemplates": { +"modelMonitors": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimeTemplates.operations.cancel", +"id": "aiplatform.modelMonitors.operations.cancel", "parameterOrder": [ "name" ], @@ -7491,7 +7198,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7506,9 +7213,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", +"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookRuntimeTemplates.operations.delete", +"id": "aiplatform.modelMonitors.operations.delete", "parameterOrder": [ "name" ], @@ -7516,7 +7223,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7531,9 +7238,9 @@ }, "get": { "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": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", +"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimeTemplates.operations.get", +"id": "aiplatform.modelMonitors.operations.get", "parameterOrder": [ "name" ], @@ -7541,7 +7248,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7556,9 +7263,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", +"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimeTemplates.operations.list", +"id": "aiplatform.modelMonitors.operations.list", "parameterOrder": [ "name" ], @@ -7571,7 +7278,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+$", +"pattern": "^modelMonitors/[^/]+$", "required": true, "type": "string" }, @@ -7602,9 +7309,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimeTemplates.operations.wait", +"id": "aiplatform.modelMonitors.operations.wait", "parameterOrder": [ "name" ], @@ -7612,7 +7319,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7635,15 +7342,17 @@ } } }, -"notebookRuntimes": { +"models": { +"resources": { +"evaluations": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimes.operations.cancel", +"id": "aiplatform.models.evaluations.operations.cancel", "parameterOrder": [ "name" ], @@ -7651,7 +7360,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7666,9 +7375,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.notebookRuntimes.operations.delete", +"id": "aiplatform.models.evaluations.operations.delete", "parameterOrder": [ "name" ], @@ -7676,7 +7385,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7691,9 +7400,9 @@ }, "get": { "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": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimes.operations.get", +"id": "aiplatform.models.evaluations.operations.get", "parameterOrder": [ "name" ], @@ -7701,7 +7410,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7716,9 +7425,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", +"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", "httpMethod": "GET", -"id": "aiplatform.notebookRuntimes.operations.list", +"id": "aiplatform.models.evaluations.operations.list", "parameterOrder": [ "name" ], @@ -7731,7 +7440,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+$", "required": true, "type": "string" }, @@ -7762,9 +7471,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.notebookRuntimes.operations.wait", +"id": "aiplatform.models.evaluations.operations.wait", "parameterOrder": [ "name" ], @@ -7772,7 +7481,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7795,15 +7504,13 @@ } } }, -"onlineEvaluators": { -"resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.onlineEvaluators.operations.cancel", +"id": "aiplatform.models.operations.cancel", "parameterOrder": [ "name" ], @@ -7811,7 +7518,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7826,9 +7533,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.onlineEvaluators.operations.delete", +"id": "aiplatform.models.operations.delete", "parameterOrder": [ "name" ], @@ -7836,7 +7543,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7851,9 +7558,9 @@ }, "get": { "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": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.onlineEvaluators.operations.get", +"id": "aiplatform.models.operations.get", "parameterOrder": [ "name" ], @@ -7861,7 +7568,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7876,9 +7583,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations", +"flatPath": "v1beta1/models/{modelsId}/operations", "httpMethod": "GET", -"id": "aiplatform.onlineEvaluators.operations.list", +"id": "aiplatform.models.operations.list", "parameterOrder": [ "name" ], @@ -7891,7 +7598,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+$", +"pattern": "^models/[^/]+$", "required": true, "type": "string" }, @@ -7922,9 +7629,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.onlineEvaluators.operations.wait", +"id": "aiplatform.models.operations.wait", "parameterOrder": [ "name" ], @@ -7932,7 +7639,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7955,167 +7662,15 @@ } } }, -"operations": { -"methods": { -"cancel": { -"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": "v1beta1/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "aiplatform.operations.cancel", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be cancelled.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:cancel", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"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`.", -"flatPath": "v1beta1/operations/{operationsId}", -"httpMethod": "DELETE", -"id": "aiplatform.operations.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to be deleted.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleProtobufEmpty" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"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": "v1beta1/operations/{operationsId}", -"httpMethod": "GET", -"id": "aiplatform.operations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/operations", -"httpMethod": "GET", -"id": "aiplatform.operations.list", -"parameterOrder": [], -"parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"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.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1beta1/operations", -"response": { -"$ref": "GoogleLongrunningListOperationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"wait": { -"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/operations/{operationsId}:wait", -"httpMethod": "POST", -"id": "aiplatform.operations.wait", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The name of the operation resource to wait on.", -"location": "path", -"pattern": "^operations/[^/]+$", -"required": true, -"type": "string" -}, -"timeout": { -"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", -"format": "google-duration", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}:wait", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"persistentResources": { +"notebookExecutionJobs": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.persistentResources.operations.cancel", +"id": "aiplatform.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -8123,7 +7678,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8138,9 +7693,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.persistentResources.operations.delete", +"id": "aiplatform.notebookExecutionJobs.operations.delete", "parameterOrder": [ "name" ], @@ -8148,7 +7703,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8163,9 +7718,9 @@ }, "get": { "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": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.persistentResources.operations.get", +"id": "aiplatform.notebookExecutionJobs.operations.get", "parameterOrder": [ "name" ], @@ -8173,7 +7728,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8188,9 +7743,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations", +"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "httpMethod": "GET", -"id": "aiplatform.persistentResources.operations.list", +"id": "aiplatform.notebookExecutionJobs.operations.list", "parameterOrder": [ "name" ], @@ -8203,7 +7758,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^persistentResources/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+$", "required": true, "type": "string" }, @@ -8234,9 +7789,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.persistentResources.operations.wait", +"id": "aiplatform.notebookExecutionJobs.operations.wait", "parameterOrder": [ "name" ], @@ -8244,7 +7799,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -8267,15 +7822,15 @@ } } }, -"pipelineJobs": { +"notebookRuntimeTemplates": { "resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.pipelineJobs.operations.cancel", +"id": "aiplatform.notebookRuntimeTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -8283,7 +7838,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8298,9 +7853,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.pipelineJobs.operations.delete", +"id": "aiplatform.notebookRuntimeTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -8308,7 +7863,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8323,9 +7878,9 @@ }, "get": { "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": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", +"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.pipelineJobs.operations.get", +"id": "aiplatform.notebookRuntimeTemplates.operations.get", "parameterOrder": [ "name" ], @@ -8333,7 +7888,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8348,9 +7903,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", +"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", -"id": "aiplatform.pipelineJobs.operations.list", +"id": "aiplatform.notebookRuntimeTemplates.operations.list", "parameterOrder": [ "name" ], @@ -8363,7 +7918,799 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^pipelineJobs/[^/]+$", +"pattern": "^notebookRuntimeTemplates/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.notebookRuntimeTemplates.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"notebookRuntimes": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.notebookRuntimes.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.notebookRuntimes.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.notebookRuntimes.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.notebookRuntimes.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.notebookRuntimes.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"onlineEvaluators": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.onlineEvaluators.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.onlineEvaluators.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.onlineEvaluators.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/operations", +"httpMethod": "GET", +"id": "aiplatform.operations.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, +"persistentResources": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.persistentResources.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.persistentResources.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.persistentResources.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.persistentResources.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^persistentResources/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.persistentResources.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^persistentResources/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"pipelineJobs": { +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.pipelineJobs.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.pipelineJobs.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.pipelineJobs.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", +"httpMethod": "GET", +"id": "aiplatform.pipelineJobs.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^pipelineJobs/[^/]+$", "required": true, "type": "string" }, @@ -20764,188 +21111,605 @@ } } }, -"indexes": { +"indexes": { +"methods": { +"create": { +"description": "Creates an Index.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/indexes", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Index" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.indexes.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets an Index.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1Index" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Imports an Index from an external source (e.g., BigQuery).", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.import", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:import", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Indexes in a Location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Mask specifying which fields to read.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/indexes", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates an Index.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"httpMethod": "PATCH", +"id": "aiplatform.projects.locations.indexes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The resource name of the Index.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1Index" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"removeDatapoints": { +"description": "Remove Datapoints from an Index.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.removeDatapoints", +"parameterOrder": [ +"index" +], +"parameters": { +"index": { +"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+index}:removeDatapoints", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"upsertDatapoints": { +"description": "Add/update Datapoints into an Index.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.upsertDatapoints", +"parameterOrder": [ +"index" +], +"parameters": { +"index": { +"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+index}:upsertDatapoints", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"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`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.indexes.operations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.indexes.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.indexes.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"interactions": { "methods": { "create": { -"description": "Creates an Index.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", +"description": "Creates an interaction.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.create", +"id": "aiplatform.projects.locations.interactions.create", "parameterOrder": [ -"parent" +"projectsId", +"locationsId" ], "parameters": { -"parent": { -"description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", +"locationsId": { +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/indexes", +"path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "request": { -"$ref": "GoogleCloudAiplatformV1beta1Index" +"$ref": "GenaiVertexV1beta1CreateInteractionRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GenaiVertexV1beta1Interaction" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"createStream": { +"description": "Creates an interaction and streams the response.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.interactions.createStream", +"parameterOrder": [ +"projectsId", +"locationsId" +], +"parameters": { +"locationsId": { +"location": "path", +"required": true, +"type": "string" +}, +"projectsId": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", +"request": { +"$ref": "GenaiVertexV1beta1CreateInteractionRequest" +}, +"response": { +"$ref": "GenaiVertexV1beta1InteractionStreamingEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { -"description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"description": "Deletes an interaction.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions/{interactionsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.indexes.delete", +"id": "aiplatform.projects.locations.interactions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/interactions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GenaiVertexV1beta1DeleteInteractionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, +"memoryBanks": { +"resources": { +"memories": { +"methods": { "get": { -"description": "Gets an Index.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", +"description": "Get a Memory.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.get", +"id": "aiplatform.projects.locations.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1Index" +"$ref": "GoogleCloudAiplatformV1beta1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"import": { -"description": "Imports an Index from an external source (e.g., BigQuery).", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", +"resources": { +"operations": { +"methods": { +"cancel": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.import", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:import", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" -}, +"path": "v1beta1/{+name}:cancel", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists Indexes in a Location.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.list", +"delete": { +"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`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", +"name": { +"description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" -}, -"readMask": { -"description": "Mask specifying which fields to read.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/indexes", +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Updates an Index.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", -"httpMethod": "PATCH", -"id": "aiplatform.projects.locations.indexes.patch", +"get": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Output only. The resource name of the Index.", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1Index" -}, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -20953,71 +21717,94 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"removeDatapoints": { -"description": "Remove Datapoints from an Index.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.removeDatapoints", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", "parameterOrder": [ -"index" +"name" ], "parameters": { -"index": { -"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+index}:removeDatapoints", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" +} }, +"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"upsertDatapoints": { -"description": "Add/update Datapoints into an Index.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.upsertDatapoints", +"id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", "parameterOrder": [ -"index" +"name" ], "parameters": { -"index": { -"description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", +"name": { +"description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1beta1/{+index}:upsertDatapoints", -"request": { -"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} }, +"path": "v1beta1/{+name}:wait", "response": { -"$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } +} +} +} }, -"resources": { "operations": { "methods": { "cancel": { "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.operations.cancel", +"id": "aiplatform.projects.locations.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -21025,7 +21812,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21040,9 +21827,9 @@ }, "delete": { "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`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", -"id": "aiplatform.projects.locations.indexes.operations.delete", +"id": "aiplatform.projects.locations.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -21050,7 +21837,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21065,9 +21852,9 @@ }, "get": { "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": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.operations.get", +"id": "aiplatform.projects.locations.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -21075,7 +21862,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -21090,9 +21877,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", -"id": "aiplatform.projects.locations.indexes.operations.list", +"id": "aiplatform.projects.locations.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -21105,7 +21892,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -21136,9 +21923,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", -"id": "aiplatform.projects.locations.indexes.operations.wait", +"id": "aiplatform.projects.locations.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -21146,7 +21933,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -21169,99 +21956,6 @@ } } }, -"interactions": { -"methods": { -"create": { -"description": "Creates an interaction.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.interactions.create", -"parameterOrder": [ -"projectsId", -"locationsId" -], -"parameters": { -"locationsId": { -"location": "path", -"required": true, -"type": "string" -}, -"projectsId": { -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", -"request": { -"$ref": "GenaiVertexV1beta1CreateInteractionRequest" -}, -"response": { -"$ref": "GenaiVertexV1beta1Interaction" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"createStream": { -"description": "Creates an interaction and streams the response.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.interactions.createStream", -"parameterOrder": [ -"projectsId", -"locationsId" -], -"parameters": { -"locationsId": { -"location": "path", -"required": true, -"type": "string" -}, -"projectsId": { -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", -"request": { -"$ref": "GenaiVertexV1beta1CreateInteractionRequest" -}, -"response": { -"$ref": "GenaiVertexV1beta1InteractionStreamingEvent" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes an interaction.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions/{interactionsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.interactions.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/interactions/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GenaiVertexV1beta1DeleteInteractionResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, "metadataStores": { "methods": { "create": { @@ -25314,7 +26008,7 @@ "type": "string" }, "orderBy": { -"description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's \"Detection time\" header sorts on. Sorted by the underlying TIMESTAMP value (newer is \"greater\" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", +"description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Subfields are not supported (no field listed below has any). Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. This is the column the landing page's \"Detection time\" header sorts on. Sorted by the underlying TIMESTAMP value (newer is \"greater\" so `latest_detection_time desc` puts the newest sessions first). * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4 (matches `Severity` enum ordering). `max_severity_rank desc` puts the most-severe sessions first. The ranking is documented here per AIP-132 because the field is not a natural-comparator type. * `agent_display_name` - the MonitoredAgent's display name as shown in the UI's \"Agent name\" column. Sorted as a STRING using BigQuery default collation (case-sensitive, code-point order). The server always appends `session_id ASC` as a stable tiebreak so pagination remains consistent across pages when the primary sort field has duplicates (e.g. multiple sessions with the same latest_detection_time within a second). If empty, defaults to `latest_detection_time desc` (the prior implicit behavior). Multi-field sort (e.g. `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", "location": "query", "type": "string" }, @@ -39395,6 +40089,31 @@ "resources": { "operations": { "methods": { +"cancel": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "delete": { "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`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", @@ -39419,6 +40138,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"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": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.tuningJobs.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.tuningJobs.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -46954,6 +47729,31 @@ "resources": { "operations": { "methods": { +"cancel": { +"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": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "aiplatform.tuningJobs.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:cancel", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "delete": { "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`.", "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", @@ -46978,6 +47778,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"get": { +"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": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "aiplatform.tuningJobs.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"wait": { +"description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", +"flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", +"httpMethod": "POST", +"id": "aiplatform.tuningJobs.operations.wait", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to wait on.", +"location": "path", +"pattern": "^tuningJobs/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +}, +"timeout": { +"description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", +"format": "google-duration", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}:wait", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -47106,7 +47962,7 @@ } } }, -"revision": "20260623", +"revision": "20260703", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { @@ -48090,6 +48946,33 @@ "description": "A tool that can be used by the model to interact with the computer.", "id": "GenaiVertexV1beta1ComputerUse", "properties": { +"disabledSafetyPolicies": { +"description": "Optional. Disabled safety policies for computer use.", +"items": { +"enum": [ +"SAFETY_POLICY_UNSPECIFIED", +"FINANCIAL_TRANSACTIONS", +"SENSITIVE_DATA_MODIFICATION", +"COMMUNICATION_TOOL", +"ACCOUNT_CREATION", +"DATA_MODIFICATION", +"USER_CONSENT_MANAGEMENT", +"LEGAL_TERMS_AND_AGREEMENTS" +], +"enumDescriptions": [ +"Unspecified safety policy.", +"Safety policy for financial transactions.", +"Safety policy for sensitive data modification.", +"Safety policy for communication tools (e.g. Gmail, Chat, Meet).", +"Safety policy for account creation.", +"Safety policy for data modification.", +"Safety policy for user consent management.", +"Safety policy for legal terms and agreements." +], +"type": "string" +}, +"type": "array" +}, "enablePromptInjectionDetection": { "description": "Whether enable the prompt injection detection check on computer-use request.", "type": "boolean" @@ -48907,6 +49790,10 @@ "description": "The maximum cumulative probability of tokens to consider when sampling.", "format": "float", "type": "number" +}, +"videoConfig": { +"$ref": "GenaiVertexV1beta1VideoConfig", +"description": "Configuration for video generation." } }, "type": "object" @@ -50155,6 +51042,10 @@ "$ref": "GenaiVertexV1beta1Content" }, "type": "array" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "The error result of the operation in case of failure or cancellation." } }, "type": "object" @@ -50346,6 +51237,9 @@ }, "text": { "$ref": "GenaiVertexV1beta1TextResponseFormat" +}, +"video": { +"$ref": "GenaiVertexV1beta1VideoResponseFormat" } }, "type": "object" @@ -50613,6 +51507,14 @@ "index": { "format": "int32", "type": "integer" +}, +"stepUsage": { +"$ref": "GenaiVertexV1beta1InteractionUsage", +"description": "Model usage stats for this specific step." +}, +"usage": { +"$ref": "GenaiVertexV1beta1InteractionUsage", +"description": "Cumulative model usage stats from the start of the session." } }, "type": "object" @@ -51324,6 +52226,10 @@ "description": "Represents a boolean value.", "type": "boolean" }, +"contentValue": { +"$ref": "GenaiVertexV1beta1Content", +"description": "Represents rich content (text, image, etc.)." +}, "listValue": { "$ref": "GenaiVertexV1beta1ListValue", "description": "Represents a repeated `Value`." @@ -51372,6 +52278,31 @@ }, "type": "object" }, +"GenaiVertexV1beta1VideoConfig": { +"description": "Configuration options for video generation.", +"id": "GenaiVertexV1beta1VideoConfig", +"properties": { +"task": { +"description": "Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media.", +"enum": [ +"TASK_UNSPECIFIED", +"TEXT_TO_VIDEO", +"IMAGE_TO_VIDEO", +"REFERENCE_TO_VIDEO", +"EDIT" +], +"enumDescriptions": [ +"Unspecified task. The task is inferred from the input prompt and media.", +"Generates video solely from a text prompt.", +"Generates video from one or two source images. The first image defines the starting frame, and the optional second image defines the ending frame.", +"Generates video using reference media (such as images, audio, or video).", +"Modifies an existing input video." +], +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1VideoContent": { "description": "A video content block.", "id": "GenaiVertexV1beta1VideoContent", @@ -51492,6 +52423,50 @@ }, "type": "object" }, +"GenaiVertexV1beta1VideoResponseFormat": { +"description": "Configuration for video output format.", +"id": "GenaiVertexV1beta1VideoResponseFormat", +"properties": { +"aspectRatio": { +"description": "The aspect ratio for the video output.", +"enum": [ +"ASPECT_RATIO_UNSPECIFIED", +"ASPECT_RATIO_SIXTEEN_BY_NINE", +"ASPECT_RATIO_NINE_BY_SIXTEEN" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"16:9 aspect ratio.", +"9:16 aspect ratio." +], +"type": "string" +}, +"delivery": { +"description": "The delivery mode for the video output.", +"enum": [ +"DELIVERY_UNSPECIFIED", +"INLINE", +"URI" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Video data is returned inline in the response.", +"Video data is returned as a URI." +], +"type": "string" +}, +"duration": { +"description": "The duration for the video output.", +"format": "google-duration", +"type": "string" +}, +"gcsUri": { +"description": "The GCS URI to store the video output. Required for Vertex if delivery mode is URI.", +"type": "string" +} +}, +"type": "object" +}, "GoogleApiHttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", "id": "GoogleApiHttpBody", @@ -54492,6 +55467,11 @@ "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", "type": "string" }, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Error while evaluating the candidate for the metric.", +"readOnly": true +}, "explanation": { "description": "Optional. The explanation for the metric.", "type": "string" @@ -54722,6 +55702,51 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1CloudLoggingConfig": { +"description": "Specifies configuration for exporting evaluation results to Cloud Logging.", +"id": "GoogleCloudAiplatformV1beta1CloudLoggingConfig", +"properties": { +"project": { +"description": "Optional. Google Cloud project to write logs to. Defaults to the request project.", +"type": "string" +}, +"resourceLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location.", +"type": "object" +}, +"resourceType": { +"description": "Optional. MonitoredResource type. Defaults to \"global\" if unspecified.", +"type": "string" +}, +"tracingContext": { +"$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext", +"description": "Optional. Tracing context for the evaluation run." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext": { +"description": "Tracing context for Observability correlation.", +"id": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext", +"properties": { +"conversationId": { +"description": "Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes.", +"type": "string" +}, +"spanId": { +"description": "Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated.", +"type": "string" +}, +"traceId": { +"description": "Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1CodeExecutionResult": { "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", @@ -58138,6 +59163,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, +"publisherModelConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig", +"description": "Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -59532,6 +60561,10 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, +"cloudLoggingConfig": { +"$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfig", +"description": "Optional. Configuration for exporting evaluation results to Cloud Logging." +}, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "items": { @@ -59653,6 +60686,10 @@ "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", "format": "int32", "type": "integer" +}, +"promptTemplate": { +"$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate", +"description": "Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used." } }, "type": "object" @@ -64853,7 +65890,7 @@ "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" }, -"description": "Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", +"description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent.", "type": "object" }, "allowCrossRegionModel": { @@ -64861,7 +65898,7 @@ "type": "boolean" }, "rootAgentId": { -"description": "Required. The agent id to identify the root agent.", +"description": "Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent.", "type": "string" }, "userScenarioGenerationConfig": { @@ -66923,6 +67960,27 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig": { +"description": "Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log.", +"id": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", +"properties": { +"state": { +"description": "Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled.", +"enum": [ +"STATE_UNSPECIFIED", +"ENABLED", +"DISABLED" +], +"enumDescriptions": [ +"Not specified. Treated as `DISABLED`.", +"Inference-event logging is enabled.", +"Inference-event logging is disabled." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1IngestEventsRequest": { "description": "Request message for MemoryBankService.IngestEvents.", "id": "GoogleCloudAiplatformV1beta1IngestEventsRequest", @@ -66931,6 +67989,10 @@ "$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource", "description": "Ingest events directly from the request." }, +"disableMemoryRevisions": { +"description": "Optional. If true, no revisions will be created for this request.", +"type": "boolean" +}, "forceFlush": { "description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", "type": "boolean" @@ -66939,6 +68001,46 @@ "$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", "description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately." }, +"metadata": { +"additionalProperties": { +"$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" +}, +"description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", +"type": "object" +}, +"metadataMergeStrategy": { +"description": "Optional. The strategy to use when applying metadata to existing memories.", +"enum": [ +"METADATA_MERGE_STRATEGY_UNSPECIFIED", +"OVERWRITE", +"MERGE", +"REQUIRE_EXACT_MATCH" +], +"enumDescriptions": [ +"Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", +"Replace the metadata of the updated memories with the new metadata.", +"Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", +"Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." +], +"type": "string" +}, +"revisionExpireTime": { +"description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", +"format": "google-datetime", +"type": "string" +}, +"revisionLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", +"type": "object" +}, +"revisionTtl": { +"description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", +"format": "google-duration", +"type": "string" +}, "scope": { "additionalProperties": { "type": "string" @@ -69616,6 +70718,11 @@ false "description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", "format": "google-duration", "type": "string" +}, +"overlapEventCount": { +"description": "Optional. Re-include the last N already-processed events in the next window.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -72470,24 +73577,10 @@ false "description": "Optional. The display name of the MonitoredAgent.", "type": "string" }, -"logBuckets": { -"description": "Optional. The log buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/buckets/{bucket}`", -"items": { -"type": "string" -}, -"type": "array" -}, "name": { "description": "Identifier. The resource name of the MonitoredAgent.", "type": "string" }, -"observabilityBuckets": { -"description": "Optional. The observability buckets configured for the agent, in MVP this will be restricted to 1. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`", -"items": { -"type": "string" -}, -"type": "array" -}, "state": { "description": "Output only. The current state of the agent's enablement.", "enum": [ @@ -76142,6 +77235,16 @@ false "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Optional. A JSONL file containing a list of files to process stored in the user's GCS bucket." }, +"inputBucketProjectNumber": { +"description": "Optional. The project number of the project that the user expects to own the input Cloud Storage bucket referenced by gcs_source. The service verifies that the bucket is actually owned by this project before reading from it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", +"format": "int64", +"type": "string" +}, +"outputBucketProjectNumber": { +"description": "Optional. The project number of the project that the user expects to own the output Cloud Storage bucket referenced by gcs_destination. The service verifies that the bucket is actually owned by this project before writing to it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", +"format": "int64", +"type": "string" +}, "veoSpec": { "$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", "description": "Optional. Spec for Veo data processing." @@ -76546,6 +77649,10 @@ false "description": "This message contains configs of a publisher model.", "id": "GoogleCloudAiplatformV1beta1PublisherModelConfig", "properties": { +"claudeFeatureConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig", +"description": "Optional. Config for Claude-specific features." +}, "dataSharingEnabledProvider": { "description": "Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected.", "enum": [ @@ -76558,6 +77665,10 @@ false ], "type": "string" }, +"inferenceEventLoggingConfig": { +"$ref": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", +"description": "Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). Logs are emitted only for projects with Provisioned Throughput, including their on-demand and spill-over traffic; enabling this on a project without Provisioned Throughput has no effect until it is provisioned. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging." +}, "loggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", "description": "Optional. The prediction request/response logging config." @@ -76565,6 +77676,22 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig": { +"description": "Config for Claude-specific features.", +"id": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig", +"properties": { +"advancedAiEnabled": { +"description": "Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read.", +"type": "boolean" +}, +"cyberVerificationProgramEnabled": { +"deprecated": true, +"description": "Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PublisherModelDocumentation": { "description": "A named piece of documentation.", "id": "GoogleCloudAiplatformV1beta1PublisherModelDocumentation", @@ -78789,6 +79916,10 @@ false "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, +"buildSpec": { +"$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", +"description": "Optional. Configuration for building container image." +}, "classMethods": { "description": "Optional. Declarations for object class methods in OpenAPI specification format.", "items": { @@ -78842,6 +79973,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec": { +"description": "Specification for building container image.", +"id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", +"properties": { +"workerPool": { +"description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec": { "description": "Specification for deploying from a container image.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec", @@ -90098,6 +91240,11 @@ false "type": "object" }, "enableDataRetention": { +"deprecated": true, +"description": "Optional. Deprecated: Use `enable_zero_data_retention` instead. 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.", +"type": "boolean" +}, +"enableZeroDataRetention": { "description": "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.", "type": "boolean" } From dcf16ca5d8e2b66a3db23a412e1e56d8a9096e2a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 04/50] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.ConnectionPoolConfig.properties.authproxyPoolerScalingType.type (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.poolerScalingType.type (Total Keys: 1) #### alloydb:v1alpha The following keys were added: - schemas.ConnectionPoolConfig.properties.authproxyPoolerScalingType.type (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.poolerScalingType.type (Total Keys: 1) #### alloydb:v1beta The following keys were added: - schemas.ConnectionPoolConfig.properties.authproxyPoolerScalingType.type (Total Keys: 1) - schemas.ConnectionPoolConfig.properties.poolerScalingType.type (Total Keys: 1) --- ...projects.locations.clusters.instances.html | 10 ++ ...projects.locations.clusters.instances.html | 10 ++ ...projects.locations.clusters.instances.html | 10 ++ .../discovery_cache/documents/alloydb.v1.json | 102 ++++++++++++---- .../documents/alloydb.v1alpha.json | 112 ++++++++++++++---- .../documents/alloydb.v1beta.json | 112 ++++++++++++++---- 6 files changed, 292 insertions(+), 64 deletions(-) diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index b8e59a1004..42f25488a2 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -140,11 +140,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -300,11 +302,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -551,11 +555,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -758,11 +764,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -907,11 +915,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index 1ee6668c87..e183503de1 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -140,11 +140,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -334,11 +336,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -619,11 +623,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -865,11 +871,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -1048,11 +1056,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index a434565824..fa0b7e329c 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -140,11 +140,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -333,11 +335,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -617,11 +621,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -862,11 +868,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. @@ -1044,11 +1052,13 @@

Method Details

}, "connectionPoolConfig": { # Configuration for Managed Connection Pool (MCP). # Optional. The configuration for Managed Connection Pool (MCP). "authproxyPoolerCount": 42, # Output only. The number of running AuthProxy poolers per instance. + "authproxyPoolerScalingType": "A String", # Optional. The scaling type of the AuthProxy pooler. "enabled": True or False, # Optional. Whether to enable Managed Connection Pool (MCP). "flags": { # Optional. Connection Pool flags, as a list of "key": "value" pairs. "a_key": "A String", }, "poolerCount": 42, # Output only. The number of running poolers per instance. + "poolerScalingType": "A String", # Optional. The scaling type of the regular pooler. }, "createTime": "A String", # Output only. Create time stamp "dataApiAccess": "A String", # Optional. Controls whether the Data API is enabled for this instance. When enabled, this allows authorized users to connect to the instance from the public internet using the `executeSql` API, even for private IP instances. If this is not specified, the data API is enabled by default for Google internal services like AlloyDB Studio. Disable it explicitly to disallow Google internal services as well. diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 46fcd8facb..df79328557 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260605", +"revision": "20260701", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2707,6 +2707,22 @@ false "readOnly": true, "type": "integer" }, +"authproxyPoolerScalingType": { +"description": "Optional. The scaling type of the AuthProxy pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" +}, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" @@ -2723,6 +2739,22 @@ false "format": "int32", "readOnly": true, "type": "integer" +}, +"poolerScalingType": { +"description": "Optional. The scaling type of the regular pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" } }, "type": "object" @@ -4507,7 +4539,7 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"", +"Unspecified availability type.", "Zonal available instance.", "Regional available instance.", "Multi regional instance", @@ -4616,7 +4648,7 @@ false "FAILED" ], "enumDescriptions": [ -"", +"Unspecified status.", "The backup was successful.", "The backup was unsuccessful." ], @@ -4742,7 +4774,7 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"", +"Unspecified feed type. Not expected to be used.", "Database resource metadata feed from control plane", "Database resource monitoring data", "Database resource security health signal data", @@ -4754,13 +4786,16 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", +"description": "Observability metric data." }, "recommendationSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", +"description": "Database resource recommendation signal data." }, "resourceHealthSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", +"description": "Database resource health signal data." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", @@ -4768,7 +4803,8 @@ false "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." }, "resourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", +"description": "Database resource metadata." }, "skipIngestion": { "description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", @@ -4829,7 +4865,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -4998,7 +5034,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -5107,6 +5146,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -5216,11 +5258,15 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" }, "state": { +"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5254,7 +5300,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -5269,7 +5315,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -5479,13 +5525,17 @@ false "MODE_UNSPECIFIED", "MODE_NATIVE", "MODE_MONGODB_COMPATIBLE", -"MODE_DATASTORE" +"MODE_DATASTORE", +"MODE_CLUSTER_ENABLED", +"MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ "Default mode.", "Native mode.", "MongoDB compatible mode.", -"Datastore mode." +"Datastore mode.", +"Memorystore/ValKey: Cluster enabled mode.", +"Memorystore/ValKey: Cluster disabled mode." ], "type": "string" }, @@ -5722,7 +5772,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -5831,6 +5884,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -5940,7 +5996,10 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" } @@ -6106,7 +6165,8 @@ false "type": "boolean" }, "product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" +"$ref": "StorageDatabasecenterProtoCommonProduct", +"description": "The product this resource represents." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" @@ -6430,6 +6490,7 @@ false "type": "string" }, "quantityBasedRetention": { +"description": "Quantity based retention period i.e. 7 backups", "format": "int32", "type": "integer" }, @@ -6454,6 +6515,7 @@ false }, "timeBasedRetention": { "deprecated": true, +"description": "Duration based retention period i.e. 172800 seconds (2 days)", "format": "google-duration", "type": "string" }, @@ -6544,7 +6606,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_MEMORSTORE_FOR_VALKEY", +"ENGINE_MEMORYSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -6588,7 +6650,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Memorystore with Valkey dialect.", +"Memorystore with Valkey.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 61f83cf74a..d106a18c4c 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -2086,7 +2086,7 @@ } } }, -"revision": "20260605", +"revision": "20260701", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2978,6 +2978,22 @@ false "readOnly": true, "type": "integer" }, +"authproxyPoolerScalingType": { +"description": "Optional. The scaling type of the AuthProxy pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" +}, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" @@ -2994,6 +3010,22 @@ false "format": "int32", "readOnly": true, "type": "integer" +}, +"poolerScalingType": { +"description": "Optional. The scaling type of the regular pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" } }, "type": "object" @@ -5062,7 +5094,7 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"", +"Unspecified availability type.", "Zonal available instance.", "Regional available instance.", "Multi regional instance", @@ -5171,7 +5203,7 @@ false "FAILED" ], "enumDescriptions": [ -"", +"Unspecified status.", "The backup was successful.", "The backup was unsuccessful." ], @@ -5297,7 +5329,7 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"", +"Unspecified feed type. Not expected to be used.", "Database resource metadata feed from control plane", "Database resource monitoring data", "Database resource security health signal data", @@ -5309,13 +5341,16 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", +"description": "Observability metric data." }, "recommendationSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", +"description": "Database resource recommendation signal data." }, "resourceHealthSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", +"description": "Database resource health signal data." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", @@ -5323,7 +5358,8 @@ false "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." }, "resourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", +"description": "Database resource metadata." }, "skipIngestion": { "description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", @@ -5384,7 +5420,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -5553,7 +5589,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -5662,6 +5701,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -5771,11 +5813,15 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" }, "state": { +"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5809,7 +5855,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -5824,7 +5870,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -6034,13 +6080,17 @@ false "MODE_UNSPECIFIED", "MODE_NATIVE", "MODE_MONGODB_COMPATIBLE", -"MODE_DATASTORE" +"MODE_DATASTORE", +"MODE_CLUSTER_ENABLED", +"MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ "Default mode.", "Native mode.", "MongoDB compatible mode.", -"Datastore mode." +"Datastore mode.", +"Memorystore/ValKey: Cluster enabled mode.", +"Memorystore/ValKey: Cluster disabled mode." ], "type": "string" }, @@ -6277,7 +6327,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -6386,6 +6439,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -6495,7 +6551,10 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" } @@ -6661,7 +6720,8 @@ false "type": "boolean" }, "product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" +"$ref": "StorageDatabasecenterProtoCommonProduct", +"description": "The product this resource represents." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" @@ -6985,6 +7045,7 @@ false "type": "string" }, "quantityBasedRetention": { +"description": "Quantity based retention period i.e. 7 backups", "format": "int32", "type": "integer" }, @@ -7009,6 +7070,7 @@ false }, "timeBasedRetention": { "deprecated": true, +"description": "Duration based retention period i.e. 172800 seconds (2 days)", "format": "google-duration", "type": "string" }, @@ -7099,7 +7161,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_MEMORSTORE_FOR_VALKEY", +"ENGINE_MEMORYSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -7143,7 +7205,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Memorystore with Valkey dialect.", +"Memorystore with Valkey.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", @@ -7663,12 +7725,18 @@ false "enum": [ "USER_TYPE_UNSPECIFIED", "ALLOYDB_BUILT_IN", -"ALLOYDB_IAM_USER" +"ALLOYDB_IAM_USER", +"ALLOYDB_IAM_GROUP", +"ALLOYDB_IAM_GROUP_USER", +"ALLOYDB_IAM_GROUP_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Unspecified user type.", "The default user type that authenticates via password-based authentication.", -"Database user that can authenticate via IAM-Based authentication." +"Database user that can authenticate via IAM-Based authentication.", +"Database user that represents an IAM group whose members can authenticate via IAM group-based authentication.", +"Represents a user that belongs to an IAM group.", +"Represents a service account that belongs to an IAM group." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index c7b3f316dc..5bdff89e94 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -2083,7 +2083,7 @@ } } }, -"revision": "20260605", +"revision": "20260701", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2959,6 +2959,22 @@ false "readOnly": true, "type": "integer" }, +"authproxyPoolerScalingType": { +"description": "Optional. The scaling type of the AuthProxy pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" +}, "enabled": { "description": "Optional. Whether to enable Managed Connection Pool (MCP).", "type": "boolean" @@ -2975,6 +2991,22 @@ false "format": "int32", "readOnly": true, "type": "integer" +}, +"poolerScalingType": { +"description": "Optional. The scaling type of the regular pooler.", +"enum": [ +"POOLER_SCALING_TYPE_UNSPECIFIED", +"POOLER_NONE", +"POOLER_MACHINE_SIZED", +"POOLER_MANUAL_OVERRIDE" +], +"enumDescriptions": [ +"The scaling type is not specified.", +"No pooler is enabled.", +"The number of poolers is automatically determined by the service based on the VM size.", +"The number of poolers is kept unchanged no matter the machine size." +], +"type": "string" } }, "type": "object" @@ -5038,7 +5070,7 @@ false "AVAILABILITY_TYPE_OTHER" ], "enumDescriptions": [ -"", +"Unspecified availability type.", "Zonal available instance.", "Regional available instance.", "Multi regional instance", @@ -5147,7 +5179,7 @@ false "FAILED" ], "enumDescriptions": [ -"", +"Unspecified status.", "The backup was successful.", "The backup was unsuccessful." ], @@ -5273,7 +5305,7 @@ false "DATABASE_RESOURCE_SIGNAL_DATA" ], "enumDescriptions": [ -"", +"Unspecified feed type. Not expected to be used.", "Database resource metadata feed from control plane", "Database resource monitoring data", "Database resource security health signal data", @@ -5285,13 +5317,16 @@ false "type": "string" }, "observabilityMetricData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" +"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", +"description": "Observability metric data." }, "recommendationSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData", +"description": "Database resource recommendation signal data." }, "resourceHealthSignalData": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", +"description": "Database resource health signal data." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", @@ -5299,7 +5334,8 @@ false "description": "Primary key associated with the Resource. resource_id is available in individual feed level as well." }, "resourceMetadata": { -"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" +"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", +"description": "Database resource metadata." }, "skipIngestion": { "description": "Optional. If true, the feed won't be ingested by DB Center. This indicates that the feed is intentionally skipped. For example, BackupDR feeds are only needed for resources integrated with DB Center (e.g., CloudSQL, AlloyDB). Feeds for non-integrated resources (e.g., Compute Engine, Persistent Disk) can be skipped.", @@ -5360,7 +5396,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -5529,7 +5565,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -5638,6 +5677,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -5747,11 +5789,15 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" }, "state": { +"description": "Required. The state of the signal, such as if it's ACTIVE or RESOLVED.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", @@ -5785,7 +5831,7 @@ false "PROVIDER_OTHER" ], "enumDescriptions": [ -"", +"Unspecified provider.", "Google cloud platform provider", "Amazon web service", "Azure web service", @@ -5800,7 +5846,7 @@ false "type": "string" }, "resourceType": { -"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", +"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -6010,13 +6056,17 @@ false "MODE_UNSPECIFIED", "MODE_NATIVE", "MODE_MONGODB_COMPATIBLE", -"MODE_DATASTORE" +"MODE_DATASTORE", +"MODE_CLUSTER_ENABLED", +"MODE_CLUSTER_DISABLED" ], "enumDescriptions": [ "Default mode.", "Native mode.", "MongoDB compatible mode.", -"Datastore mode." +"Datastore mode.", +"Memorystore/ValKey: Cluster enabled mode.", +"Memorystore/ValKey: Cluster disabled mode." ], "type": "string" }, @@ -6253,7 +6303,10 @@ false "SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES", "SIGNAL_TYPE_EXTENDED_SUPPORT", "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE", -"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE" +"SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE", +"SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK", +"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME", +"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION" ], "enumDeprecated": [ false, @@ -6362,6 +6415,9 @@ false, false, false, false, +false, +false, +false, false ], "enumDescriptions": [ @@ -6471,7 +6527,10 @@ false "Recommended maintenance policy.", "Resource version is in extended support.", "Change in performance KPIs.", -"Database version nearing end of life." +"Database version nearing end of life.", +"Indicates a high risk of maintenance downtime.", +"Indicates both a low cache hit rate and a risk of maintenance downtime.", +"Indicates that the resource is missing enhanced protection." ], "type": "string" } @@ -6637,7 +6696,8 @@ false "type": "boolean" }, "product": { -"$ref": "StorageDatabasecenterProtoCommonProduct" +"$ref": "StorageDatabasecenterProtoCommonProduct", +"description": "The product this resource represents." }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" @@ -6961,6 +7021,7 @@ false "type": "string" }, "quantityBasedRetention": { +"description": "Quantity based retention period i.e. 7 backups", "format": "int32", "type": "integer" }, @@ -6985,6 +7046,7 @@ false }, "timeBasedRetention": { "deprecated": true, +"description": "Duration based retention period i.e. 172800 seconds (2 days)", "format": "google-duration", "type": "string" }, @@ -7075,7 +7137,7 @@ false "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", -"ENGINE_MEMORSTORE_FOR_VALKEY", +"ENGINE_MEMORYSTORE_FOR_VALKEY", "ENGINE_OTHER", "ENGINE_FIRESTORE_WITH_NATIVE_MODE", "ENGINE_FIRESTORE_WITH_DATASTORE_MODE", @@ -7119,7 +7181,7 @@ false "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", -"Memorystore with Valkey dialect.", +"Memorystore with Valkey.", "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", "Firestore with native mode.", "Firestore with datastore mode.", @@ -7639,12 +7701,18 @@ false "enum": [ "USER_TYPE_UNSPECIFIED", "ALLOYDB_BUILT_IN", -"ALLOYDB_IAM_USER" +"ALLOYDB_IAM_USER", +"ALLOYDB_IAM_GROUP", +"ALLOYDB_IAM_GROUP_USER", +"ALLOYDB_IAM_GROUP_SERVICE_ACCOUNT" ], "enumDescriptions": [ "Unspecified user type.", "The default user type that authenticates via password-based authentication.", -"Database user that can authenticate via IAM-Based authentication." +"Database user that can authenticate via IAM-Based authentication.", +"Database user that represents an IAM group whose members can authenticate via IAM group-based authentication.", +"Represents a user that belongs to an IAM group.", +"Represents a service account that belongs to an IAM group." ], "type": "string" } From 24cda798f95f49894ceb5004fa84bf51435eff7c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 05/50] feat(androidpublisher): update the api #### androidpublisher:v3 The following keys were added: - resources.orders.methods.reviewrefund (Total Keys: 13) - schemas.CoarseLocation (Total Keys: 6) - schemas.ConsumptionUsageEvent (Total Keys: 8) - schemas.OrdersReviewRefundRequest (Total Keys: 9) --- docs/dyn/androidpublisher_v3.orders.html | 42 ++++++ .../documents/androidpublisher.v3.json | 131 +++++++++++++++++- 2 files changed, 172 insertions(+), 1 deletion(-) diff --git a/docs/dyn/androidpublisher_v3.orders.html b/docs/dyn/androidpublisher_v3.orders.html index 1f6fb447e0..41da5fef52 100644 --- a/docs/dyn/androidpublisher_v3.orders.html +++ b/docs/dyn/androidpublisher_v3.orders.html @@ -86,6 +86,9 @@

Instance Methods

refund(packageName, orderId, revoke=None, x__xgafv=None)

Refunds a user's subscription or in-app purchase order. Orders older than 3 years cannot be refunded.

+

+ reviewrefund(packageName, orderId, body=None, x__xgafv=None)

+

Provide refund preference and purchase usage for a chargeback request

Method Details

batchget(packageName, orderIds=None, x__xgafv=None) @@ -413,4 +416,43 @@

Method Details

+
+ reviewrefund(packageName, orderId, body=None, x__xgafv=None) +
Provide refund preference and purchase usage for a chargeback request
+
+Args:
+  packageName: string, Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing'). (required)
+  orderId: string, Required. The order ID provided to the user when the subscription or in-app order was purchased. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the orders.reviewrefund API.
+  "consumptionPercentageMilliunits": 42, # Optional. Percentage of the In-App purchase the customer consumed, in milliunits. Minimum: 0 Maximum: 100,000. For paid apps, this can be omitted. Example : 45200 represents 45.2%.
+  "consumptionUsageEvents": [ # Optional. List of events, each representing an instance where the user consumed or used the purchased item or service. Lists with over 1000 items will be rejected.
+    { # List of events, each representing an instance where the user consumed or used the purchased item or service.
+      "consumptionItemDescription": "A String", # Optional. Free form text that allows developers to provide more info on the item consumed. Maximum length is 5000 characters.
+      "consumptionTime": "A String", # Optional. Time when the user consumed, used, downloaded, opened, or streamed the content.
+      "ipAddress": "A String", # Optional. The IP address from which the consumption occurred.
+      "location": { # Coarse Geographic location details for where the consumption happened. # Optional. Geographic location where the consumption occurred.
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty.
+        "regionCode": "A String", # Required. [CLDR region code](https://cldr.unicode.org/) of the country/region of the address. This value is never inferred and you must ensure the value is correct. Example: "CH" for Switzerland.
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. For most addresses, you can omit this.
+      },
+      "obfuscatedAccountId": "A String", # Optional. Obfuscated string that is uniquely associated with the purchaser's user account in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId(java.lang.String)
+      "obfuscatedProfileId": "A String", # Optional. Obfuscated string that is uniquely associated with the purchaser's user profile in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedProfileId(java.lang.String)
+    },
+  ],
+  "pendingRefundToken": "A String", # Required. The pending refund token included in the pending refund review notification.
+  "refundPreference": "A String", # Required. Indicates your preference, based on your operational logic, as to whether the Play Store should grant the refund.
+  "sampleContentProvided": True or False, # Required. Indicates whether you provided a free sample, trial, or information about the functionality prior to the purchase.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 602c2c238c..fea0e53585 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -4662,6 +4662,37 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] +}, +"reviewrefund": { +"description": "Provide refund preference and purchase usage for a chargeback request", +"flatPath": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund", +"httpMethod": "POST", +"id": "androidpublisher.orders.reviewrefund", +"parameterOrder": [ +"packageName", +"orderId" +], +"parameters": { +"orderId": { +"description": "Required. The order ID provided to the user when the subscription or in-app order was purchased.", +"location": "path", +"required": true, +"type": "string" +}, +"packageName": { +"description": "Required. The package name of the application for which this subscription or in-app item was purchased (for example, 'com.some.thing').", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/orders/{orderId}:reviewrefund", +"request": { +"$ref": "OrdersReviewRefundRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] } } }, @@ -5654,7 +5685,7 @@ } } }, -"revision": "20260625", +"revision": "20260706", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -7001,6 +7032,29 @@ }, "type": "object" }, +"CoarseLocation": { +"description": "Coarse Geographic location details for where the consumption happened.", +"id": "CoarseLocation", +"properties": { +"administrativeArea": { +"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", +"type": "string" +}, +"locality": { +"description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty.", +"type": "string" +}, +"regionCode": { +"description": "Required. [CLDR region code](https://cldr.unicode.org/) of the country/region of the address. This value is never inferred and you must ensure the value is correct. Example: \"CH\" for Switzerland.", +"type": "string" +}, +"sublocality": { +"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district. For most addresses, you can omit this.", +"type": "string" +} +}, +"type": "object" +}, "Comment": { "description": "An entry of conversation between user and developer.", "id": "Comment", @@ -7016,6 +7070,38 @@ }, "type": "object" }, +"ConsumptionUsageEvent": { +"description": "List of events, each representing an instance where the user consumed or used the purchased item or service.", +"id": "ConsumptionUsageEvent", +"properties": { +"consumptionItemDescription": { +"description": "Optional. Free form text that allows developers to provide more info on the item consumed. Maximum length is 5000 characters.", +"type": "string" +}, +"consumptionTime": { +"description": "Optional. Time when the user consumed, used, downloaded, opened, or streamed the content.", +"format": "google-datetime", +"type": "string" +}, +"ipAddress": { +"description": "Optional. The IP address from which the consumption occurred.", +"type": "string" +}, +"location": { +"$ref": "CoarseLocation", +"description": "Optional. Geographic location where the consumption occurred." +}, +"obfuscatedAccountId": { +"description": "Optional. Obfuscated string that is uniquely associated with the purchaser's user account in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedAccountId(java.lang.String)", +"type": "string" +}, +"obfuscatedProfileId": { +"description": "Optional. Obfuscated string that is uniquely associated with the purchaser's user profile in the app. https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setObfuscatedProfileId(java.lang.String)", +"type": "string" +} +}, +"type": "object" +}, "ConvertRegionPricesRequest": { "description": "Request message for ConvertRegionPrices.", "id": "ConvertRegionPricesRequest", @@ -10126,6 +10212,49 @@ false }, "type": "object" }, +"OrdersReviewRefundRequest": { +"description": "Request for the orders.reviewrefund API.", +"id": "OrdersReviewRefundRequest", +"properties": { +"consumptionPercentageMilliunits": { +"description": "Optional. Percentage of the In-App purchase the customer consumed, in milliunits. Minimum: 0 Maximum: 100,000. For paid apps, this can be omitted. Example : 45200 represents 45.2%.", +"format": "int32", +"type": "integer" +}, +"consumptionUsageEvents": { +"description": "Optional. List of events, each representing an instance where the user consumed or used the purchased item or service. Lists with over 1000 items will be rejected.", +"items": { +"$ref": "ConsumptionUsageEvent" +}, +"type": "array" +}, +"pendingRefundToken": { +"description": "Required. The pending refund token included in the pending refund review notification.", +"type": "string" +}, +"refundPreference": { +"description": "Required. Indicates your preference, based on your operational logic, as to whether the Play Store should grant the refund.", +"enum": [ +"REFUND_PREFERENCE_UNSPECIFIED", +"DECLINE", +"APPROVE", +"NEUTRAL" +], +"enumDescriptions": [ +"Refund preference unspecified. This value is not used.", +"Developer prefers that Play declines the refund.", +"Developer prefers that Play grants the refund in full.", +"Developer has no preference about Google Play's decision to issue a refund" +], +"type": "string" +}, +"sampleContentProvided": { +"description": "Required. Indicates whether you provided a free sample, trial, or information about the functionality prior to the purchase.", +"type": "boolean" +} +}, +"type": "object" +}, "OtherRecurringProduct": { "description": "Details of a recurring external transaction product which doesn't belong to any other more specific category.", "id": "OtherRecurringProduct", From ee13aa4fe890a298d48532b319c3c34a5c9cb051 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 06/50] feat(apigee): update the api #### apigee:v1 The following keys were added: - schemas.GoogleCloudApigeeV1RuntimeTraceConfig.properties.spanSemantics.type (Total Keys: 1) - schemas.GoogleCloudApigeeV1RuntimeTraceConfigOverride.properties.spanSemantics.type (Total Keys: 1) - schemas.GoogleCloudApigeeV1TraceConfig.properties.spanSemantics.type (Total Keys: 1) --- .../apigee_v1.organizations.environments.html | 9 +++- .../discovery_cache/documents/apigee.v1.json | 48 +++++++++++++++++-- 2 files changed, 52 insertions(+), 5 deletions(-) diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html index a17243a3f9..067cfb6084 100644 --- a/docs/dyn/apigee_v1.organizations.environments.html +++ b/docs/dyn/apigee_v1.organizations.environments.html @@ -680,13 +680,13 @@

Method Details

}, }, ], - "traceConfig": { # NEXT ID: 10 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies. + "traceConfig": { # NEXT ID: 11 RuntimeTraceConfig defines the configurations for distributed trace in an environment. # Trace configurations. Contains config for the environment and config overrides for specific API proxies. "endpoint": "A String", # Endpoint of the exporter. "exporter": "A String", # Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. "name": "A String", # Name of the trace config in the following format: `organizations/{org}/environment/{env}/traceConfig` "openTelemetryProtocolEnabled": True or False, # Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead. "overrides": [ # List of trace configuration overrides for spicific API proxies. - { # NEXT ID: 9 Trace configuration override for a specific API proxy in an environment. + { # NEXT ID: 10 Trace configuration override for a specific API proxy in an environment. "apiProxy": "A String", # Name of the API proxy that will have its trace configuration overridden following format: `organizations/{org}/apis/{api}` "name": "A String", # Name of the trace config override in the following format: `organizations/{org}/environment/{env}/traceConfig/overrides/{override}` "openTelemetryProtocolEnabled": True or False, # Optional. If `true`, the runtime uses OpenTelemetry Protocol (OTLP) to send trace data. Configuration Requirements (if `open_telemetry_protocol_enabled` is `true`): - Allowed `Exporter`s: `CLOUD_TRACE` or `OPEN_TELEMETRY_COLLECTOR`. - If `Exporter` is `OPEN_TELEMETRY_COLLECTOR`: - `endpoint` refers to a valid OTLP collector URL. - If `Exporter` is `CLOUD_TRACE`: - `endpoint` refers to a valid project ID Deprecated: Use trace_protocol instead. @@ -696,6 +696,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "spanSemantics": "A String", # Optional. The span semantics to use. Configuration Requirements (if `span_semantics` is `OTEL`): - `trace_protocol` must be `OTLP`. "traceProtocol": "A String", # Optional. The trace protocol to use. "uid": "A String", # Unique ID for the configuration override. The ID will only change if the override is deleted and recreated. Corresponds to name's "override" field. }, @@ -706,6 +707,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "spanSemantics": "A String", # Optional. The span semantics to use. Configuration Requirements (if `span_semantics` is `OTEL`): - `trace_protocol` must be `OTLP`. "traceProtocol": "A String", # Optional. The trace protocol to use. }, "uid": "A String", # Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. @@ -802,6 +804,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "spanSemantics": "A String", # Optional. The span semantics to use. Configuration Requirements (if span_semantics is OTEL): - trace_protocol must be OTLP. "traceProtocol": "A String", # Optional. The trace protocol to use. Configuration Requirements (if trace_protocol is OTLP): - Allowed Exporters: CLOUD_TRACE or OPEN_TELEMETRY_COLLECTOR. - If Exporter is OPEN_TELEMETRY_COLLECTOR: - endpoint refers to a valid OTLP collector URL. - If Exporter is CLOUD_TRACE: - endpoint refers to a valid project ID. } @@ -1328,6 +1331,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "spanSemantics": "A String", # Optional. The span semantics to use. Configuration Requirements (if span_semantics is OTEL): - trace_protocol must be OTLP. "traceProtocol": "A String", # Optional. The trace protocol to use. Configuration Requirements (if trace_protocol is OTLP): - Allowed Exporters: CLOUD_TRACE or OPEN_TELEMETRY_COLLECTOR. - If Exporter is OPEN_TELEMETRY_COLLECTOR: - endpoint refers to a valid OTLP collector URL. - If Exporter is CLOUD_TRACE: - endpoint refers to a valid project ID. } @@ -1347,6 +1351,7 @@

Method Details

"sampler": "A String", # Sampler of distributed tracing. OFF is the default value. "samplingRate": 3.14, # Field sampling rate. This value is only applicable when using the PROBABILITY sampler. The supported values are > 0 and <= 0.5. }, + "spanSemantics": "A String", # Optional. The span semantics to use. Configuration Requirements (if span_semantics is OTEL): - trace_protocol must be OTLP. "traceProtocol": "A String", # Optional. The trace protocol to use. Configuration Requirements (if trace_protocol is OTLP): - Allowed Exporters: CLOUD_TRACE or OPEN_TELEMETRY_COLLECTOR. - If Exporter is OPEN_TELEMETRY_COLLECTOR: - endpoint refers to a valid OTLP collector URL. - If Exporter is CLOUD_TRACE: - endpoint refers to a valid project ID. } diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index 37bb493b68..d1a60f25f7 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -11964,7 +11964,7 @@ } } }, -"revision": "20260622", +"revision": "20260626", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -19188,7 +19188,7 @@ "type": "object" }, "GoogleCloudApigeeV1RuntimeTraceConfig": { -"description": "NEXT ID: 10 RuntimeTraceConfig defines the configurations for distributed trace in an environment.", +"description": "NEXT ID: 11 RuntimeTraceConfig defines the configurations for distributed trace in an environment.", "id": "GoogleCloudApigeeV1RuntimeTraceConfig", "properties": { "endpoint": { @@ -19242,6 +19242,20 @@ "$ref": "GoogleCloudApigeeV1RuntimeTraceSamplingConfig", "description": "Trace configuration for all API proxies in an environment." }, +"spanSemantics": { +"description": "Optional. The span semantics to use. Configuration Requirements (if `span_semantics` is `OTEL`): - `trace_protocol` must be `OTLP`.", +"enum": [ +"SPAN_SEMANTICS_UNSPECIFIED", +"LEGACY", +"OTEL" +], +"enumDescriptions": [ +"Semantics unspecified. Defaults to LEGACY.", +"Uses Apigee legacy span and attribute names.", +"Uses OpenTelemetry semantic-convention-aligned span and attribute names." +], +"type": "string" +}, "traceProtocol": { "description": "Optional. The trace protocol to use.", "enum": [ @@ -19260,7 +19274,7 @@ "type": "object" }, "GoogleCloudApigeeV1RuntimeTraceConfigOverride": { -"description": "NEXT ID: 9 Trace configuration override for a specific API proxy in an environment.", +"description": "NEXT ID: 10 Trace configuration override for a specific API proxy in an environment.", "id": "GoogleCloudApigeeV1RuntimeTraceConfigOverride", "properties": { "apiProxy": { @@ -19289,6 +19303,20 @@ "$ref": "GoogleCloudApigeeV1RuntimeTraceSamplingConfig", "description": "Trace configuration override for a specific API proxy in an environment." }, +"spanSemantics": { +"description": "Optional. The span semantics to use. Configuration Requirements (if `span_semantics` is `OTEL`): - `trace_protocol` must be `OTLP`.", +"enum": [ +"SPAN_SEMANTICS_UNSPECIFIED", +"LEGACY", +"OTEL" +], +"enumDescriptions": [ +"Semantics unspecified. Defaults to LEGACY.", +"Uses Apigee legacy span and attribute names.", +"Uses OpenTelemetry semantic-convention-aligned span and attribute names." +], +"type": "string" +}, "traceProtocol": { "description": "Optional. The trace protocol to use.", "enum": [ @@ -21302,6 +21330,20 @@ "$ref": "GoogleCloudApigeeV1TraceSamplingConfig", "description": "Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API." }, +"spanSemantics": { +"description": "Optional. The span semantics to use. Configuration Requirements (if span_semantics is OTEL): - trace_protocol must be OTLP.", +"enum": [ +"SPAN_SEMANTICS_UNSPECIFIED", +"LEGACY", +"OTEL" +], +"enumDescriptions": [ +"Semantics unspecified. Defaults to LEGACY.", +"Uses Apigee legacy span and attribute names.", +"Uses OpenTelemetry semantic-convention-aligned span and attribute names." +], +"type": "string" +}, "traceProtocol": { "description": "Optional. The trace protocol to use. Configuration Requirements (if trace_protocol is OTLP): - Allowed Exporters: CLOUD_TRACE or OPEN_TELEMETRY_COLLECTOR. - If Exporter is OPEN_TELEMETRY_COLLECTOR: - endpoint refers to a valid OTLP collector URL. - If Exporter is CLOUD_TRACE: - endpoint refers to a valid project ID.", "enum": [ From 0f80196c6e289da777ce1d9b408b6389d01ec678 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 07/50] feat(authorizedbuyersmarketplace): update the api #### authorizedbuyersmarketplace:v1alpha The following keys were added: - schemas.CuratedPackage.properties.millipercentOfMediaFee (Total Keys: 2) - schemas.DataSegment.properties.millipercentOfMediaFee (Total Keys: 2) #### authorizedbuyersmarketplace:v1beta The following keys were added: - schemas.CuratedPackage.properties.millipercentOfMediaFee (Total Keys: 2) - schemas.DataSegment.properties.millipercentOfMediaFee (Total Keys: 2) --- ...uyersmarketplace_v1alpha.buyers.dataSegments.html | 8 ++++++++ ...marketplace_v1alpha.curators.curatedPackages.html | 8 ++++++++ ...smarketplace_v1beta.curators.curatedPackages.html | 8 ++++++++ ...yersmarketplace_v1beta.curators.dataSegments.html | 8 ++++++++ .../authorizedbuyersmarketplace.v1alpha.json | 12 +++++++++++- .../authorizedbuyersmarketplace.v1beta.json | 12 +++++++++++- 6 files changed, 54 insertions(+), 2 deletions(-) diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html index 19177d57ae..a578d4073a 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html @@ -126,6 +126,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -153,6 +154,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -173,6 +175,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -206,6 +209,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -233,6 +237,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -264,6 +269,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -303,6 +309,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -324,6 +331,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html index 8a6852c490..b4691b8bc6 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.curators.curatedPackages.html @@ -138,6 +138,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -303,6 +304,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -461,6 +463,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -632,6 +635,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -797,6 +801,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -967,6 +972,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -1144,6 +1150,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -1303,6 +1310,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html index 1899d6fe04..009bfe47ab 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.curatedPackages.html @@ -138,6 +138,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -303,6 +304,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -461,6 +463,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -632,6 +635,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -797,6 +801,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -967,6 +972,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -1144,6 +1150,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. @@ -1303,6 +1310,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}` "state": "A String", # Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method. "targeting": { # Targeting criteria for curated and auction packages. # Optional. Targeting criteria for the curated package. diff --git a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html index 9c300d9ef9..0a3195ea64 100644 --- a/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html +++ b/docs/dyn/authorizedbuyersmarketplace_v1beta.curators.dataSegments.html @@ -126,6 +126,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -153,6 +154,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -173,6 +175,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -206,6 +209,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -233,6 +237,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -264,6 +269,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -303,6 +309,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. @@ -324,6 +331,7 @@

Method Details

"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, "createTime": "A String", # Output only. Time the data segment was created. + "millipercentOfMediaFee": "A String", # Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000. "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}` "state": "A String", # Output only. The state of the data segment. "updateTime": "A String", # Output only. Time the data segment was last updated. diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json index c6140dc5c4..7811ad87f3 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json @@ -1806,7 +1806,7 @@ } } }, -"revision": "20260609", +"revision": "20260708", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -2279,6 +2279,11 @@ "$ref": "Money", "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method." }, +"millipercentOfMediaFee": { +"description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.", +"format": "int64", +"type": "string" +}, "name": { "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "type": "string" @@ -2325,6 +2330,11 @@ "readOnly": true, "type": "string" }, +"millipercentOfMediaFee": { +"description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.", +"format": "int64", +"type": "string" +}, "name": { "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json index d127b49b49..f88e8114b6 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1beta.json @@ -517,7 +517,7 @@ } } }, -"revision": "20260609", +"revision": "20260708", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AccessControlSettings": { @@ -634,6 +634,11 @@ "$ref": "Money", "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method." }, +"millipercentOfMediaFee": { +"description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.", +"format": "int64", +"type": "string" +}, "name": { "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`", "type": "string" @@ -680,6 +685,11 @@ "readOnly": true, "type": "string" }, +"millipercentOfMediaFee": { +"description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.", +"format": "int64", +"type": "string" +}, "name": { "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. v1alpha format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` v1beta format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`", "type": "string" From 67aec7b5c522e917c7096c1521337b4b98a3cbb4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 08/50] fix(backupdr): update the api #### backupdr:v1 The following keys were changed: - resources.folders.resources.locations.resources.resourceBackupConfigs.methods.fetch.scopes (Total Keys: 1) - resources.organizations.resources.locations.resources.resourceBackupConfigs.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.getTrial.scopes (Total Keys: 1) - resources.projects.resources.locations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.fetchForResourceType.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlanAssociations.methods.triggerBackup.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlans.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlans.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlans.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlans.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupPlans.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.fetchUsable.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.methods.testIamPermissions.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.abandonBackup.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.fetchAccessToken.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.finalizeBackup.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.initiateBackup.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.remove.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.methods.setInternalStatus.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.fetchForResourceType.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.patch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.backupVaults.resources.dataSources.resources.backups.methods.restore.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataSourceReferences.methods.fetchForResourceType.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataSourceReferences.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.dataSourceReferences.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.getIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.msComplianceMetadata.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.setIamPolicy.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.managementServers.methods.testIamPermissions.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.cancel.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.operations.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.fetch.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.resourceBackupConfigs.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.serviceConfig.methods.initialize.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.trial.methods.end.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.trial.methods.subscribe.scopes (Total Keys: 1) --- ...pdr_v1.projects.locations.backupPlans.html | 8 +-- ...jects.locations.backupPlans.revisions.html | 4 +- .../documents/backupdr.v1.json | 68 ++++++++++++++++++- 3 files changed, 72 insertions(+), 8 deletions(-) diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html index 54a3b93abb..aeb39833db 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -131,7 +131,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -268,7 +268,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -345,7 +345,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -431,7 +431,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html index 5939b176a5..900a0aa67b 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.revisions.html @@ -123,7 +123,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], @@ -204,7 +204,7 @@

Method Details

"daysOfWeek": [ # Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. "A String", ], - "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. + "hourlyFrequency": 42, # Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details. "months": [ # Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 964414769f..a48f04d4eb 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/cloud-backupdr": { +"description": "See, edit, configure, and delete your Google Cloud Backup and DR data and see the email address for your Google Account" +}, "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." } @@ -391,6 +394,7 @@ "$ref": "FetchResourceBackupConfigsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -449,6 +453,7 @@ "$ref": "FetchResourceBackupConfigsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -484,6 +489,7 @@ "$ref": "Location" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -509,6 +515,7 @@ "$ref": "Trial" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -556,6 +563,7 @@ "$ref": "ListLocationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -598,6 +606,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -628,6 +637,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -679,6 +689,7 @@ "$ref": "FetchBackupPlanAssociationsForResourceTypeResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -704,6 +715,7 @@ "$ref": "BackupPlanAssociation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -745,6 +757,7 @@ "$ref": "ListBackupPlanAssociationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -784,6 +797,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -812,6 +826,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -854,6 +869,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -884,6 +900,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -909,6 +926,7 @@ "$ref": "BackupPlan" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -955,6 +973,7 @@ "$ref": "ListBackupPlansResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -994,6 +1013,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1023,6 +1043,7 @@ "$ref": "BackupPlanRevision" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1059,6 +1080,7 @@ "$ref": "ListBackupPlanRevisionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1108,6 +1130,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1163,6 +1186,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1209,6 +1233,7 @@ "$ref": "FetchUsableBackupVaultsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1249,6 +1274,7 @@ "$ref": "BackupVault" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1310,6 +1336,7 @@ "$ref": "ListBackupVaultsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1364,6 +1391,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1392,6 +1420,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1424,6 +1453,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1452,6 +1482,7 @@ "$ref": "FetchAccessTokenResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1480,6 +1511,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1505,6 +1537,7 @@ "$ref": "DataSource" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1533,6 +1566,7 @@ "$ref": "InitiateBackupResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1579,6 +1613,7 @@ "$ref": "ListDataSourcesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1623,6 +1658,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1651,6 +1687,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1679,6 +1716,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1713,6 +1751,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1779,6 +1818,7 @@ "$ref": "FetchBackupsForResourceTypeResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1819,6 +1859,7 @@ "$ref": "Backup" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1880,6 +1921,7 @@ "$ref": "ListBackupsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1919,6 +1961,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1947,6 +1990,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2006,6 +2050,7 @@ "$ref": "FetchDataSourceReferencesForResourceTypeResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2031,6 +2076,7 @@ "$ref": "DataSourceReference" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2077,6 +2123,7 @@ "$ref": "ListDataSourceReferencesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2119,6 +2166,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2149,6 +2197,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2174,6 +2223,7 @@ "$ref": "ManagementServer" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2205,6 +2255,7 @@ "$ref": "Policy" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2251,6 +2302,7 @@ "$ref": "ListManagementServersResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2279,6 +2331,7 @@ "$ref": "FetchMsComplianceMetadataResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2307,6 +2360,7 @@ "$ref": "Policy" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2335,6 +2389,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2367,6 +2422,7 @@ "$ref": "Empty" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2392,6 +2448,7 @@ "$ref": "Empty" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2417,6 +2474,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2463,6 +2521,7 @@ "$ref": "ListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2513,6 +2572,7 @@ "$ref": "FetchResourceBackupConfigsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2559,6 +2619,7 @@ "$ref": "ListResourceBackupConfigsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2591,6 +2652,7 @@ "$ref": "Operation" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2623,6 +2685,7 @@ "$ref": "Trial" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2651,6 +2714,7 @@ "$ref": "Trial" }, "scopes": [ +"https://www.googleapis.com/auth/cloud-backupdr", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2661,7 +2725,7 @@ } } }, -"revision": "20260621", +"revision": "20260701", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -6983,7 +7047,7 @@ "type": "array" }, "hourlyFrequency": { -"description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 4-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.", +"description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 1 means jobs will run every 1 hour from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. The supported values for each resource type are as follows: * `compute.googleapis.com/Instance`: 1-23 * `compute.googleapis.com/Disk`: 1-23 * `sqladmin.googleapis.com/Instance`: 6-23 * `alloydb.googleapis.com/Cluster`: 1-23 * `file.googleapis.com/Instance`: 1-23 Refer to link https://cloud.google.com/backup-disaster-recovery/docs/concepts/cloud_best_practices for more details.", "format": "int32", "type": "integer" }, From dc3d306ce2139fe7173f17cc6d5286d12981da15 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 09/50] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.ArrowRecordBatch (Total Keys: 4) - schemas.ArrowSchema (Total Keys: 4) - schemas.ArrowSerializationOptions (Total Keys: 4) - schemas.QueryRequest.properties.arrowSerializationOptions.$ref (Total Keys: 1) - schemas.QueryRequest.properties.queryResultsFormat.type (Total Keys: 1) - schemas.QueryResponse.properties.arrowRecordBatch (Total Keys: 2) - schemas.QueryResponse.properties.arrowSchema (Total Keys: 2) - schemas.QueryResponse.properties.pageRowCount (Total Keys: 3) --- docs/dyn/bigquery_v2.jobs.html | 46 +++++---- docs/dyn/bigquery_v2.tables.html | 28 +++--- .../documents/bigquery.v2.json | 99 ++++++++++++++++++- 3 files changed, 140 insertions(+), 33 deletions(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index fc8a1e40bb..4243d79d83 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -292,7 +292,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -568,7 +568,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1508,7 +1508,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1928,7 +1928,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -2204,7 +2204,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3144,7 +3144,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3447,7 +3447,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3672,7 +3672,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3948,7 +3948,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -4888,7 +4888,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -5279,7 +5279,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -5555,7 +5555,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -6495,7 +6495,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -6909,7 +6909,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -7185,7 +7185,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -8127,7 +8127,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -8370,6 +8370,10 @@

Method Details

The object takes the form of: { # Describes the format of the jobs.query request. + "arrowSerializationOptions": { # Contains options specific to Arrow Serialization. This feature is not yet available. # Optional. Options specific to the Apache Arrow output format. + "bufferCompression": "A String", # The compression codec to use for Arrow buffers in serialized record batches. + "picosTimestampPrecision": "A String", # Optional. Set timestamp precision option. If not set, the default precision is microseconds. + }, "connectionProperties": [ # Optional. Connection properties which can modify the query behavior. { # A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: * **dataset_project_id**: represents the default project for datasets that are used in the query. Setting the system variable `@@dataset_project_id` achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables * **time_zone**: represents the default timezone used to run the query. * **session_id**: associates the query with a given session. * **query_label**: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration * **service_account**: indicates the service account to use to run a continuous query. If set, the query job uses the service account to access Google Cloud resources. Service account access is bounded by the IAM permissions that you have granted to the service account. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error. "key": "A String", # The key of the property to set. @@ -8434,6 +8438,7 @@

Method Details

}, }, ], + "queryResultsFormat": "A String", # Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available. "requestId": "A String", # Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. "reservation": "A String", # Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. "timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. @@ -8451,6 +8456,12 @@

Method Details

An object of the form: { + "arrowRecordBatch": { # Arrow RecordBatch. This feature is not yet available. # Output only. Serialized row data in Arrow RecordBatch format. + "serializedRecordBatch": "A String", # IPC-serialized Arrow RecordBatch. + }, + "arrowSchema": { # Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available. # Output only. Arrow schema + "serializedSchema": "A String", # IPC serialized Arrow schema. + }, "cacheHit": True or False, # Whether the query result was fetched from the query cache. "creationTime": "A String", # Output only. Creation time of this query, in milliseconds since the epoch. This field will be present on all queries. "dmlStats": { # Detailed statistics for DML statements # Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE. @@ -8481,6 +8492,7 @@

Method Details

"kind": "bigquery#queryResponse", # The resource type. "location": "A String", # Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. + "pageRowCount": "A String", # Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available. "pageToken": "A String", # A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results). "queryId": "A String", # Auto-generated ID for the query. "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. @@ -8527,7 +8539,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 064a4f2950..7581d628a4 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -317,7 +317,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -494,7 +494,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -862,7 +862,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1039,7 +1039,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1348,7 +1348,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1525,7 +1525,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -1942,7 +1942,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -2119,7 +2119,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -2429,7 +2429,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -2606,7 +2606,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3034,7 +3034,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3211,7 +3211,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3521,7 +3521,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. @@ -3698,7 +3698,7 @@

Method Details

"generatedColumn": { # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). # Optional. Definition of how values are generated for the field. Only valid for top-level schema fields (not nested fields). "generatedExpressionInfo": { # Definition of the expression used to generate the field. # Definition of the expression used to generate the field. "asynchronous": True or False, # Optional. Whether the column generation is done asynchronously. - "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field. + "generationExpression": "A String", # Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field. "stored": True or False, # Optional. Whether the generated column is stored in the table. }, "generatedMode": "A String", # Optional. Dictates when system generated values are used to populate the field. diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 63c54ea8a8..46f27a8844 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -2390,7 +2390,7 @@ } } }, -"revision": "20260612", +"revision": "20260620", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2832,6 +2832,67 @@ }, "type": "object" }, +"ArrowRecordBatch": { +"description": "Arrow RecordBatch. This feature is not yet available.", +"id": "ArrowRecordBatch", +"properties": { +"serializedRecordBatch": { +"description": "IPC-serialized Arrow RecordBatch.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"ArrowSchema": { +"description": "Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available.", +"id": "ArrowSchema", +"properties": { +"serializedSchema": { +"description": "IPC serialized Arrow schema.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"ArrowSerializationOptions": { +"description": "Contains options specific to Arrow Serialization. This feature is not yet available.", +"id": "ArrowSerializationOptions", +"properties": { +"bufferCompression": { +"description": "The compression codec to use for Arrow buffers in serialized record batches.", +"enum": [ +"COMPRESSION_UNSPECIFIED", +"LZ4_FRAME", +"ZSTD" +], +"enumDescriptions": [ +"If unspecified no compression will be used.", +"LZ4 Frame (https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md)", +"Zstandard compression." +], +"type": "string" +}, +"picosTimestampPrecision": { +"description": "Optional. Set timestamp precision option. If not set, the default precision is microseconds.", +"enum": [ +"PICOS_TIMESTAMP_PRECISION_UNSPECIFIED", +"TIMESTAMP_PRECISION_MICROS", +"TIMESTAMP_PRECISION_NANOS", +"TIMESTAMP_PRECISION_PICOS" +], +"enumDescriptions": [ +"Unspecified timestamp precision. The default precision is microseconds.", +"Timestamp values returned in the results will be truncated to microsecond level precision. The value will be encoded as Arrow TIMESTAMP type in a 64 bit integer.", +"Timestamp values returned in the results will be truncated to nanosecond level precision. The value will be encoded as Arrow TIMESTAMP type in a 64 bit integer.", +"Timestamp values returned in the results will contain full precision picosecond value. The value will be encoded as a string which conforms to ISO 8601 format." +], +"type": "string" +} +}, +"type": "object" +}, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -5033,7 +5094,7 @@ "type": "boolean" }, "generationExpression": { -"description": "Optional. The generation expression (e.g. AI.EMBED(...)) used to generated the field.", +"description": "Optional. The generation expression (e.g. AI.EMBED(...)) used to generate the field.", "type": "string" }, "stored": { @@ -8179,6 +8240,10 @@ "description": "Describes the format of the jobs.query request.", "id": "QueryRequest", "properties": { +"arrowSerializationOptions": { +"$ref": "ArrowSerializationOptions", +"description": "Optional. Options specific to the Apache Arrow output format." +}, "connectionProperties": { "description": "Optional. Connection properties which can modify the query behavior.", "items": { @@ -8280,6 +8345,20 @@ }, "type": "array" }, +"queryResultsFormat": { +"description": "Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available.", +"enum": [ +"QUERY_RESULTS_FORMAT_UNSPECIFIED", +"STRUCT_ENCODING", +"ARROW" +], +"enumDescriptions": [ +"If unspecified it will default to struct `QueryResponse.rows` (`STRUCT_ENCODING`)", +"Default encoding of results as struct in `QueryResponse.rows`", +"Arrow is a standard open source column-based message format. See https://arrow.apache.org/ for more details." +], +"type": "string" +}, "requestId": { "description": "Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.", "type": "string" @@ -8313,6 +8392,16 @@ "QueryResponse": { "id": "QueryResponse", "properties": { +"arrowRecordBatch": { +"$ref": "ArrowRecordBatch", +"description": "Output only. Serialized row data in Arrow RecordBatch format.", +"readOnly": true +}, +"arrowSchema": { +"$ref": "ArrowSchema", +"description": "Output only. Arrow schema", +"readOnly": true +}, "cacheHit": { "description": "Whether the query result was fetched from the query cache.", "type": "boolean" @@ -8370,6 +8459,12 @@ "readOnly": true, "type": "string" }, +"pageRowCount": { +"description": "Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "pageToken": { "description": "A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results).", "type": "string" From 220cfd714e1d9ce6502addf039b1eb768350f38a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 10/50] feat(bigquerydatatransfer): update the api #### bigquerydatatransfer:v1 The following keys were deleted: - schemas.TransferRun.properties.metadataDestination (Total Keys: 2) --- ...transfer_v1.projects.locations.transferConfigs.html | 10 ---------- ...fer_v1.projects.locations.transferConfigs.runs.html | 10 ---------- ...gquerydatatransfer_v1.projects.transferConfigs.html | 10 ---------- ...ydatatransfer_v1.projects.transferConfigs.runs.html | 10 ---------- .../documents/bigquerydatatransfer.v1.json | 7 +------ 5 files changed, 1 insertion(+), 46 deletions(-) diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html index 5b5c779003..4e2ebffbe6 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.html @@ -630,11 +630,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq @@ -695,11 +690,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html index f6ea634b01..767714ab68 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html @@ -148,11 +148,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq @@ -215,11 +210,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html index cd8f8c1bdb..aac67b40b0 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html @@ -630,11 +630,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq @@ -695,11 +690,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq diff --git a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html index dd0841630b..5036a52350 100644 --- a/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html +++ b/docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.runs.html @@ -148,11 +148,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq @@ -215,11 +210,6 @@

Method Details

], "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. }, - "metadataDestination": { # The metadata destination of the transfer config. # Output only. The metadata destination of the transfer run. - "dataplexConfiguration": { # Configuration for Dataplex destination. # The Dataplex Universal Catalog configuration. - "entryGroup": "A String", # Required. The Dataplex Universal Catalog entry group for importing the metadata. entry_group has the format of `projects/{project_id}/locations/{region}/entryGroups/{entry_group_id}`. - }, - }, "name": "A String", # Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project_id}/topics/{topic_id}` "params": { # Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index ade3c0b11e..b54eaf6441 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1651,7 +1651,7 @@ } } }, -"revision": "20260601", +"revision": "20260703", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -2639,11 +2639,6 @@ "$ref": "Status", "description": "Status of the transfer run." }, -"metadataDestination": { -"$ref": "MetadataDestination", -"description": "Output only. The metadata destination of the transfer run.", -"readOnly": true -}, "name": { "description": "Identifier. The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run.", "type": "string" From 1c2fda49c8217f79111c31a996b26a6db06d468a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 11/50] feat(bigqueryreservation): update the api #### bigqueryreservation:v1 The following keys were added: - resources.projects.resources.locations.resources.reservationGroups.methods.patch (Total Keys: 15) - schemas.ReservationGroup.properties.parentGroup.type (Total Keys: 1) --- ....projects.locations.reservationGroups.html | 36 ++++++++++++++ .../documents/bigqueryreservation.v1.json | 49 +++++++++++++++++-- 2 files changed, 80 insertions(+), 5 deletions(-) diff --git a/docs/dyn/bigqueryreservation_v1.projects.locations.reservationGroups.html b/docs/dyn/bigqueryreservation_v1.projects.locations.reservationGroups.html index 932e42f2b6..7b223b3c32 100644 --- a/docs/dyn/bigqueryreservation_v1.projects.locations.reservationGroups.html +++ b/docs/dyn/bigqueryreservation_v1.projects.locations.reservationGroups.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Updates an existing reservation group resource.

Method Details

close() @@ -109,6 +112,7 @@

Method Details

{ # A reservation group is a container for reservations. "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups. } reservationGroupId: string, Required. The reservation group ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. @@ -122,6 +126,7 @@

Method Details

{ # A reservation group is a container for reservations. "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups. }
@@ -159,6 +164,7 @@

Method Details

{ # A reservation group is a container for reservations. "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups. } @@ -183,6 +189,7 @@

Method Details

"reservationGroups": [ # List of reservations visible to the user. { # A reservation group is a container for reservations. "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. + "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups. }, ], } @@ -202,4 +209,33 @@

Method Details

+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing reservation group resource.
+
+Args:
+  name: string, Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A reservation group is a container for reservations.
+  "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
+  "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups.
+}
+
+  updateMask: string, Optional. Standard field mask for the set of fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A reservation group is a container for reservations.
+  "name": "A String", # Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
+  "parentGroup": "A String", # Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 60d5676117..a72008f574 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -736,6 +736,41 @@ "https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates an existing reservation group resource.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reservationGroups/{reservationGroupsId}", +"httpMethod": "PATCH", +"id": "bigqueryreservation.projects.locations.reservationGroups.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/reservationGroups/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Standard field mask for the set of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "ReservationGroup" +}, +"response": { +"$ref": "ReservationGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1282,7 +1317,7 @@ } } }, -"revision": "20260410", +"revision": "20260629", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -1540,7 +1575,7 @@ ], "enumDeprecated": [ false, -false, +true, true, true, false, @@ -1552,7 +1587,7 @@ false ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", -"Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", +"Deprecated: Flex commitments are deprecated. Please use Edition-based capacity commitments. Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", "Same as FLEX, should only be used if flat-rate commitments are still available.", "Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", @@ -1580,7 +1615,7 @@ false ], "enumDeprecated": [ false, -false, +true, true, true, false, @@ -1592,7 +1627,7 @@ false ], "enumDescriptions": [ "Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.", -"Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", +"Deprecated: Flex commitments are deprecated. Please use Edition-based capacity commitments. Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", "Same as FLEX, should only be used if flat-rate commitments are still available.", "Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.", "Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.", @@ -1969,6 +2004,10 @@ false "name": { "description": "Identifier. The resource name of the reservation group, e.g., `projects/*/locations/*/reservationGroups/team1-prod`. The reservation_group_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.", "type": "string" +}, +"parentGroup": { +"description": "Optional. The parent reservation group of the reservation group. Format: `projects/*/locations/*/reservationGroups/team1-prod` for non-root reservation groups, or `projects/*/locations/*` for root reservation groups.", +"type": "string" } }, "type": "object" From f4885d0eda944de8d6a8712c4fc78b8d1b29c7ba Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 12/50] feat(calendar): update the api #### calendar:v3 The following keys were added: - resources.calendarList.methods.list.parameters.showOwnOrganizationOnly (Total Keys: 2) - resources.calendarList.methods.watch.parameters.showOwnOrganizationOnly (Total Keys: 2) - resources.calendars.methods.transferOwnership (Total Keys: 14) - resources.events.methods.import.parameters.eventLabelVersion (Total Keys: 5) - resources.events.methods.insert.parameters.eventLabelVersion (Total Keys: 5) - resources.events.methods.patch.parameters.eventLabelVersion (Total Keys: 5) - resources.events.methods.update.parameters.eventLabelVersion (Total Keys: 5) - schemas.Calendar.properties.labelProperties.$ref (Total Keys: 1) - schemas.Event.properties.eventLabelId.type (Total Keys: 1) - schemas.EventLabel.properties.backgroundColor.type (Total Keys: 1) - schemas.EventLabel.properties.id.type (Total Keys: 1) - schemas.EventLabel.properties.name.type (Total Keys: 1) - schemas.LabelProperties.properties.eventLabels (Total Keys: 2) --- docs/dyn/calendar_v3.acl.html | 8 ++ docs/dyn/calendar_v3.calendarList.html | 22 +++- docs/dyn/calendar_v3.calendars.html | 107 +++++++++++++++ docs/dyn/calendar_v3.events.html | 74 +++++++++-- .../documents/calendar.v3.json | 122 +++++++++++++++++- 5 files changed, 312 insertions(+), 21 deletions(-) diff --git a/docs/dyn/calendar_v3.acl.html b/docs/dyn/calendar_v3.acl.html index 6fd638a5f2..948b9abc3e 100644 --- a/docs/dyn/calendar_v3.acl.html +++ b/docs/dyn/calendar_v3.acl.html @@ -136,6 +136,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -167,6 +168,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -193,6 +195,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -235,6 +238,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -286,6 +290,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -312,6 +317,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -344,6 +350,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -370,6 +377,7 @@

Method Details

# - "none" - Provides no access. # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. diff --git a/docs/dyn/calendar_v3.calendarList.html b/docs/dyn/calendar_v3.calendarList.html index f50d65370d..68b04b65ba 100644 --- a/docs/dyn/calendar_v3.calendarList.html +++ b/docs/dyn/calendar_v3.calendarList.html @@ -87,7 +87,7 @@

Instance Methods

insert(body=None, colorRgbFormat=None)

Inserts an existing calendar into the user's calendar list.

- list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)

+ list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, showOwnOrganizationOnly=None, syncToken=None)

Returns the calendars on the user's calendar list.

list_next()

@@ -99,7 +99,7 @@

Instance Methods

update(calendarId, body=None, colorRgbFormat=None)

Updates an existing calendar on the user's calendar list.

- watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None)

+ watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, showOwnOrganizationOnly=None, syncToken=None)

Watch for changes to CalendarList resources.

Method Details

@@ -130,6 +130,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -200,6 +201,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -266,6 +268,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -325,7 +328,7 @@

Method Details

- list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None) + list(maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, showOwnOrganizationOnly=None, syncToken=None)
Returns the calendars on the user's calendar list.
 
 Args:
@@ -340,8 +343,9 @@ 

Method Details

pageToken: string, Token specifying which result page to return. Optional. showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False. showHidden: boolean, Whether to show hidden entries. Optional. The default is False. + showOwnOrganizationOnly: boolean, Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False. syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. -To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. +To ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. @@ -356,6 +360,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -446,6 +451,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -512,6 +518,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -583,6 +590,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -649,6 +657,7 @@

Method Details

"accessRole": "A String", # The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: # - "freeBusyReader" - Provides read access to free/busy information. # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -708,7 +717,7 @@

Method Details

- watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, syncToken=None) + watch(body=None, maxResults=None, minAccessRole=None, pageToken=None, showDeleted=None, showHidden=None, showOwnOrganizationOnly=None, syncToken=None)
Watch for changes to CalendarList resources.
 
 Args:
@@ -741,8 +750,9 @@ 

Method Details

pageToken: string, Token specifying which result page to return. Optional. showDeleted: boolean, Whether to include deleted calendar list entries in the result. Optional. The default is False. showHidden: boolean, Whether to show hidden entries. Optional. The default is False. + showOwnOrganizationOnly: boolean, Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False. syncToken: string, Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. -To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. +To ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Learn more about incremental synchronization. Optional. The default is to return all entries. diff --git a/docs/dyn/calendar_v3.calendars.html b/docs/dyn/calendar_v3.calendars.html index 0ecefa051d..c43955bfd8 100644 --- a/docs/dyn/calendar_v3.calendars.html +++ b/docs/dyn/calendar_v3.calendars.html @@ -92,6 +92,9 @@

Instance Methods

patch(calendarId, body=None)

Updates metadata for a calendar. This method supports patch semantics.

+

+ transferOwnership(calendarId, newDataOwner, useAdminAccess)

+

Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes:

update(calendarId, body=None)

Updates metadata for a calendar.

@@ -145,6 +148,19 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. @@ -178,6 +194,19 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. @@ -203,6 +232,19 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. @@ -234,6 +276,19 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. @@ -259,12 +314,38 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. }
+
+ transferOwnership(calendarId, newDataOwner, useAdminAccess) +
Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes: 
+- https://www.googleapis.com/auth/calendar 
+- https://www.googleapis.com/auth/calendar.calendars In the request, set useAdminAccess to true. The secondary calendar must be active to be transferred. Transferring disabled or deleted calendars isn't supported.
+
+Args:
+  calendarId: string, Calendar identifier. To retrieve calendar IDs, call the calendarList.list method. (required)
+  newDataOwner: string, The email address of a user who will become the data owner of the calendar. (required)
+  useAdminAccess: boolean, When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the Manage Calendars privilege. This method currently only supports admin access, thus only true is accepted for this field. (required)
+
+
+
update(calendarId, body=None)
Updates metadata for a calendar.
@@ -290,6 +371,19 @@ 

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. @@ -315,6 +409,19 @@

Method Details

"etag": "A String", # ETag of the resource. "id": "A String", # Identifier of the calendar. To retrieve IDs call the calendarList.list() method. "kind": "calendar#calendar", # Type of the resource ("calendar#calendar"). + "labelProperties": { # Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged. + "eventLabels": [ # Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels. + # Extend the list to add a new event label, and remove entities from the list to delete a label from calendar. + # Each calendar can have a maximum of 200 labels. + { + "backgroundColor": "A String", # Background color of the label in hexadecimal format, such as "#039be5". Events with this label are displayed in this color. Required. + "id": "A String", # The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label. + # If provided, the ID must be unique within the calendar and follow UUID format. + "name": "A String", # Name of the label. Optional. + # If provided this must have at most 50 characters. + }, + ], + }, "location": "A String", # Geographic location of the calendar as free-form text. Optional. "summary": "A String", # Title of the calendar. "timeZone": "A String", # The time zone of the calendar. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) Optional. diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index f19b7eec7c..0fbc9b43b5 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -84,10 +84,10 @@

Instance Methods

get(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, timeZone=None)

Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.

- import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None)

+ import_(calendarId, body=None, conferenceDataVersion=None, eventLabelVersion=None, supportsAttachments=None)

Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.

- insert(calendarId, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

+ insert(calendarId, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

Creates an event.

instances(calendarId, eventId, alwaysIncludeEmail=None, maxAttendees=None, maxResults=None, originalStart=None, pageToken=None, showDeleted=None, timeMax=None, timeMin=None, timeZone=None)

@@ -105,13 +105,13 @@

Instance Methods

move(calendarId, eventId, destination, sendNotifications=None, sendUpdates=None)

Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.

- patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

+ patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

Updates an event. This method supports patch semantics.

quickAdd(calendarId, text, sendNotifications=None, sendUpdates=None)

Creates an event based on a simple text string.

- update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

+ update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)

Updates an event.

watch(calendarId, alwaysIncludeEmail=None, body=None, eventTypes=None, iCalUID=None, maxAttendees=None, maxResults=None, orderBy=None, pageToken=None, privateExtendedProperty=None, q=None, sharedExtendedProperty=None, showDeleted=None, showHiddenInvitations=None, singleEvents=None, syncToken=None, timeMax=None, timeMin=None, timeZone=None, updatedMin=None)

@@ -321,6 +321,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -434,6 +437,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -456,7 +460,7 @@

Method Details

- import_(calendarId, body=None, conferenceDataVersion=None, supportsAttachments=None) + import_(calendarId, body=None, conferenceDataVersion=None, eventLabelVersion=None, supportsAttachments=None)
Imports an event. This operation is used to add a private copy of an existing event to a calendar. Only events with an eventType of default may be imported.
 Deprecated behavior: If a non-default event is imported, its type will be changed to default and any event-type-specific properties it may have will be dropped.
 
@@ -632,6 +636,9 @@ 

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -745,6 +752,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -766,6 +774,7 @@

Method Details

} conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. + eventLabelVersion: integer, Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0. supportsAttachments: boolean, Whether API client performing operation supports event attachments. Optional. The default is False. Returns: @@ -938,6 +947,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -1051,6 +1063,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -1073,7 +1086,7 @@

Method Details

- insert(calendarId, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None) + insert(calendarId, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)
Creates an event.
 
 Args:
@@ -1248,6 +1261,9 @@ 

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -1361,6 +1377,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -1382,6 +1399,7 @@

Method Details

} conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. + eventLabelVersion: integer, Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0. maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. sendNotifications: boolean, Deprecated. Please use sendUpdates instead. @@ -1563,6 +1581,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -1676,6 +1697,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -1722,6 +1744,7 @@

Method Details

# - "none" - The user has no access. # - "freeBusyReader" - The user has read access to free/busy information. # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -1905,6 +1928,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -2018,6 +2044,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -2130,6 +2157,7 @@

Method Details

# - "none" - The user has no access. # - "freeBusyReader" - The user has read access to free/busy information. # - "reader" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. + # - "writerWithoutPrivateAccess" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. # - "writer" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. # - "owner" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users. # Important: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role. @@ -2313,6 +2341,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -2426,6 +2457,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -2656,6 +2688,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -2769,6 +2804,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -2791,7 +2827,7 @@

Method Details

- patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None) + patch(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)
Updates an event. This method supports patch semantics.
 
 Args:
@@ -2967,6 +3003,9 @@ 

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -3080,6 +3119,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -3102,6 +3142,7 @@

Method Details

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. + eventLabelVersion: integer, Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0. maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. sendNotifications: boolean, Deprecated. Please use sendUpdates instead. @@ -3283,6 +3324,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -3396,6 +3440,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -3603,6 +3648,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -3716,6 +3764,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -3738,7 +3787,7 @@

Method Details

- update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None) + update(calendarId, eventId, alwaysIncludeEmail=None, body=None, conferenceDataVersion=None, eventLabelVersion=None, maxAttendees=None, sendNotifications=None, sendUpdates=None, supportsAttachments=None)
Updates an event.
 
 Args:
@@ -3914,6 +3963,9 @@ 

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -4027,6 +4079,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. @@ -4049,6 +4102,7 @@

Method Details

alwaysIncludeEmail: boolean, Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided). conferenceDataVersion: integer, Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event's body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. + eventLabelVersion: integer, Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0. maxAttendees: integer, The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. sendNotifications: boolean, Deprecated. Please use sendUpdates instead. @@ -4230,6 +4284,9 @@

Method Details

}, "endTimeUnspecified": false, # Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False. "etag": "A String", # ETag of the resource. + "eventLabelId": "A String", # The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.) + # This property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods. + # Setting an empty string, or not setting this field at all, will remove the existing label from the event. "eventType": "default", # Specific type of the event. This cannot be modified after the event is created. Possible values are: # - "birthday" - A special all-day event with an annual recurrence. # - "default" - A regular event or not further specified. @@ -4343,6 +4400,7 @@

Method Details

# - "public" - The event is public and event details are visible to all readers of the calendar. # - "private" - The event is private and only event attendees may view event details. # - "confidential" - The event is private. This value is provided for compatibility reasons. + # Note on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event. "workingLocationProperties": { # Working location event data. "customLocation": { # If present, specifies that the user is working from a custom location. "label": "A String", # An optional extra label for additional information. diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 8ca0fbad21..d0fee5888e 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -513,8 +513,13 @@ "location": "query", "type": "boolean" }, +"showOwnOrganizationOnly": { +"description": "Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.", +"location": "query", +"type": "boolean" +}, "syncToken": { -"description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", +"description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "location": "query", "type": "string" } @@ -643,8 +648,13 @@ "location": "query", "type": "boolean" }, +"showOwnOrganizationOnly": { +"description": "Whether to show only entries for calendars from the organization. This parameter is only applicable to Google Workspace users. Optional. The default is False.", +"location": "query", +"type": "boolean" +}, "syncToken": { -"description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", +"description": "Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won't be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False.\nTo ensure client state consistency minAccessRole and showOwnOrganizationOnly query parameters cannot be specified together with nextSyncToken.\nIf the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken.\nLearn more about incremental synchronization.\nOptional. The default is to return all entries.", "location": "query", "type": "string" } @@ -784,6 +794,41 @@ "https://www.googleapis.com/auth/calendar.calendars" ] }, +"transferOwnership": { +"description": "Transfers a secondary calendar between users within a Google Workspace organization. Requires user authentication with Manage Calendars administrator privilege, and one of the following authorization scopes: \n- https://www.googleapis.com/auth/calendar \n- https://www.googleapis.com/auth/calendar.calendars In the request, set useAdminAccess to true. The secondary calendar must be active to be transferred. Transferring disabled or deleted calendars isn't supported.", +"httpMethod": "POST", +"id": "calendar.calendars.transferOwnership", +"parameterOrder": [ +"calendarId", +"newDataOwner", +"useAdminAccess" +], +"parameters": { +"calendarId": { +"description": "Calendar identifier. To retrieve calendar IDs, call the calendarList.list method.", +"location": "path", +"required": true, +"type": "string" +}, +"newDataOwner": { +"description": "The email address of a user who will become the data owner of the calendar.", +"location": "query", +"required": true, +"type": "string" +}, +"useAdminAccess": { +"description": "When true, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the Manage Calendars privilege. This method currently only supports admin access, thus only true is accepted for this field.", +"location": "query", +"required": true, +"type": "boolean" +} +}, +"path": "calendars/{calendarId}/transferOwnership", +"scopes": [ +"https://www.googleapis.com/auth/calendar", +"https://www.googleapis.com/auth/calendar.calendars" +] +}, "update": { "description": "Updates metadata for a calendar.", "httpMethod": "PUT", @@ -997,6 +1042,14 @@ "minimum": "0", "type": "integer" }, +"eventLabelVersion": { +"description": "Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.", +"format": "int32", +"location": "query", +"maximum": "1", +"minimum": "0", +"type": "integer" +}, "supportsAttachments": { "description": "Whether API client performing operation supports event attachments. Optional. The default is False.", "location": "query", @@ -1039,6 +1092,14 @@ "minimum": "0", "type": "integer" }, +"eventLabelVersion": { +"description": "Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.", +"format": "int32", +"location": "query", +"maximum": "1", +"minimum": "0", +"type": "integer" +}, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", @@ -1426,6 +1487,14 @@ "required": true, "type": "string" }, +"eventLabelVersion": { +"description": "Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.", +"format": "int32", +"location": "query", +"maximum": "1", +"minimum": "0", +"type": "integer" +}, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", @@ -1560,6 +1629,14 @@ "required": true, "type": "string" }, +"eventLabelVersion": { +"description": "Version number of the event label feature supported by the API client. Version 0 assumes no event label support and processes the colorId field for color management. Version 1 enables support for event labels, and processes the eventLabelId in the event's body. In this case, the colorId field is ignored. The default is 0.", +"format": "int32", +"location": "query", +"maximum": "1", +"minimum": "0", +"type": "integer" +}, "maxAttendees": { "description": "The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.", "format": "int32", @@ -1894,7 +1971,7 @@ } } }, -"revision": "20260614", +"revision": "20260708", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -1949,7 +2026,7 @@ "calendar.acl.insert" ] }, -"description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", +"description": "The role assigned to the scope. Possible values are: \n- \"none\" - Provides no access. \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. Provides read access to the calendar's ACLs. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", "type": "string" }, "scope": { @@ -2013,6 +2090,10 @@ "description": "Type of the resource (\"calendar#calendar\").", "type": "string" }, +"labelProperties": { +"$ref": "LabelProperties", +"description": "Label properties defined on this calendar. If specified, overwrites the existing label properties. If not specified, the label properties remain unchanged." +}, "location": { "description": "Geographic location of the calendar as free-form text. Optional.", "type": "string" @@ -2067,7 +2148,7 @@ "id": "CalendarListEntry", "properties": { "accessRole": { -"description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", +"description": "The effective access role that the authenticated user has on the calendar. Read-only. Possible values are: \n- \"freeBusyReader\" - Provides read access to free/busy information. \n- \"reader\" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - Provides read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - Provides manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", "type": "string" }, "autoAcceptInvitations": { @@ -2569,6 +2650,10 @@ "description": "ETag of the resource.", "type": "string" }, +"eventLabelId": { +"description": "The ID of the event label assigned to the event. Optional. This refers to the ID of an entry in the labelProperties.eventLabels property of the calendar (see the Calendars.get endpoint.)\nThis property supersedes the index-based colorId property. To set or change this property, you need to specify eventLabelVersion=1 in the parameters of the insert, import, update, and patch methods.\nSetting an empty string, or not setting this field at all, will remove the existing label from the event.", +"type": "string" +}, "eventType": { "default": "default", "description": "Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"birthday\" - A special all-day event with an annual recurrence. \n- \"default\" - A regular event or not further specified. \n- \"focusTime\" - A focus-time event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created. \n- \"outOfOffice\" - An out-of-office event. \n- \"workingLocation\" - A working location event.", @@ -2808,7 +2893,7 @@ }, "visibility": { "default": "default", -"description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons.", +"description": "Visibility of the event. Optional. Possible values are: \n- \"default\" - Uses the default visibility for events on the calendar. This is the default value. \n- \"public\" - The event is public and event details are visible to all readers of the calendar. \n- \"private\" - The event is private and only event attendees may view event details. \n- \"confidential\" - The event is private. This value is provided for compatibility reasons. \nNote on recurring events: Changing the visibility of a single instance of a recurring event can affect all instances of the series. If the new setting is more restrictive (e.g. from public to private), it is applied to all instances. If the new setting is less restrictive (e.g. from private to public), the change is ignored. To make a recurring event less restrictive, you must update the parent recurring event.", "type": "string" }, "workingLocationProperties": { @@ -2959,6 +3044,20 @@ }, "EventLabel": { "id": "EventLabel", +"properties": { +"backgroundColor": { +"description": "Background color of the label in hexadecimal format, such as \"#039be5\". Events with this label are displayed in this color. Required.", +"type": "string" +}, +"id": { +"description": "The ID of the label. Optional when inserting a new label. If not provided, a unique ID will be generated. Required when updating a label.\nIf provided, the ID must be unique within the calendar and follow UUID format.", +"type": "string" +}, +"name": { +"description": "Name of the label. Optional.\nIf provided this must have at most 50 characters.", +"type": "string" +} +}, "type": "object" }, "EventOutOfOfficeProperties": { @@ -3044,7 +3143,7 @@ "id": "Events", "properties": { "accessRole": { -"description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", +"description": "The user's access role for this calendar. Read-only. Possible values are: \n- \"none\" - The user has no access. \n- \"freeBusyReader\" - The user has read access to free/busy information. \n- \"reader\" - The user has read access to the calendar. Private events will appear to users with reader access, but event details will be hidden. \n- \"writerWithoutPrivateAccess\" - The user has read and write access to the calendar. Private events will appear to users with writerWithoutPrivateAccess access, but event details will be hidden. \n- \"writer\" - The user has read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible. \n- \"owner\" - The user has manager access to the calendar. This role has all of the permissions of the writer role with the additional ability to see and modify access levels of other users.\nImportant: the owner role is different from the calendar's data owner. A calendar has a single data owner, but can have multiple users with owner role.", "type": "string" }, "defaultReminders": { @@ -3225,6 +3324,15 @@ }, "LabelProperties": { "id": "LabelProperties", +"properties": { +"eventLabels": { +"description": "Event labels defined on this calendar. If this is present when updating the calendar, it will replace the existing event labels.\nExtend the list to add a new event label, and remove entities from the list to delete a label from calendar.\nEach calendar can have a maximum of 200 labels.", +"items": { +"$ref": "EventLabel" +}, +"type": "array" +} +}, "type": "object" }, "Setting": { From 11e53578ffaf28dfa97836dc63265d2fb6915ab5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:46 +0000 Subject: [PATCH 13/50] feat(certificatemanager): update the api #### certificatemanager:v1 The following keys were added: - schemas.Certificate.properties.tags (Total Keys: 2) - schemas.CertificateIssuanceConfig.properties.tags (Total Keys: 2) - schemas.CertificateMap.properties.tags (Total Keys: 2) - schemas.DnsAuthorization.properties.tags (Total Keys: 2) - schemas.TrustConfig.properties.tags (Total Keys: 2) --- ....locations.certificateIssuanceConfigs.html | 12 ++++++ ...v1.projects.locations.certificateMaps.html | 12 ++++++ ...er_v1.projects.locations.certificates.html | 12 ++++++ ....projects.locations.dnsAuthorizations.html | 12 ++++++ ...er_v1.projects.locations.trustConfigs.html | 12 ++++++ .../documents/certificatemanager.v1.json | 37 ++++++++++++++++++- 6 files changed, 96 insertions(+), 1 deletion(-) diff --git a/docs/dyn/certificatemanager_v1.projects.locations.certificateIssuanceConfigs.html b/docs/dyn/certificatemanager_v1.projects.locations.certificateIssuanceConfigs.html index 882186ca7e..07faf23ea5 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.certificateIssuanceConfigs.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.certificateIssuanceConfigs.html @@ -125,6 +125,9 @@

Method Details

"lifetime": "A String", # Required. Workload certificate lifetime requested. "name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. "rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig. } @@ -222,6 +225,9 @@

Method Details

"lifetime": "A String", # Required. Workload certificate lifetime requested. "name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. "rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig. }
@@ -261,6 +267,9 @@

Method Details

"lifetime": "A String", # Required. Workload certificate lifetime requested. "name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. "rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig. }, ], @@ -309,6 +318,9 @@

Method Details

"lifetime": "A String", # Required. Workload certificate lifetime requested. "name": "A String", # Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. "rotationWindowPercentage": 42, # Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a CertificateIssuanceConfig. } diff --git a/docs/dyn/certificatemanager_v1.projects.locations.certificateMaps.html b/docs/dyn/certificatemanager_v1.projects.locations.certificateMaps.html index a77263ed45..15d6f4a1dd 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.certificateMaps.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.certificateMaps.html @@ -136,6 +136,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The update timestamp of a Certificate Map. } @@ -239,6 +242,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The update timestamp of a Certificate Map. } @@ -284,6 +290,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The update timestamp of a Certificate Map. }, ], @@ -338,6 +347,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The update timestamp of a Certificate Map. } diff --git a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html index 8e635b0547..61893917f3 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.certificates.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.certificates.html @@ -181,6 +181,9 @@

Method Details

"pemCertificate": "A String", # Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. "pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. "usedBy": [ # Output only. The list of resources that use this Certificate. { # Defines a resource that uses the certificate. @@ -339,6 +342,9 @@

Method Details

"pemCertificate": "A String", # Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. "pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. "usedBy": [ # Output only. The list of resources that use this Certificate. { # Defines a resource that uses the certificate. @@ -439,6 +445,9 @@

Method Details

"pemCertificate": "A String", # Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. "pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. "usedBy": [ # Output only. The list of resources that use this Certificate. { # Defines a resource that uses the certificate. @@ -548,6 +557,9 @@

Method Details

"pemCertificate": "A String", # Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. "pemPrivateKey": "A String", # Optional. Input only. The PEM-encoded private key of the leaf certificate. }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "updateTime": "A String", # Output only. The last update timestamp of a Certificate. "usedBy": [ # Output only. The list of resources that use this Certificate. { # Defines a resource that uses the certificate. diff --git a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html index e8c900d27d..223eef0653 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html @@ -123,6 +123,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "type": "A String", # Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } @@ -219,6 +222,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "type": "A String", # Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } @@ -257,6 +263,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "type": "A String", # Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. }, @@ -304,6 +313,9 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "type": "A String", # Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } diff --git a/docs/dyn/certificatemanager_v1.projects.locations.trustConfigs.html b/docs/dyn/certificatemanager_v1.projects.locations.trustConfigs.html index b5acbac943..170487f74d 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.trustConfigs.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.trustConfigs.html @@ -137,6 +137,9 @@

Method Details

], }, }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "trustStores": [ # Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. { # Defines a trust store. "intermediateCas": [ # Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. @@ -261,6 +264,9 @@

Method Details

], }, }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "trustStores": [ # Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. { # Defines a trust store. "intermediateCas": [ # Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. @@ -327,6 +333,9 @@

Method Details

], }, }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "trustStores": [ # Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. { # Defines a trust store. "intermediateCas": [ # Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. @@ -400,6 +409,9 @@

Method Details

], }, }, + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + "a_key": "A String", + }, "trustStores": [ # Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. { # Defines a trust store. "intermediateCas": [ # Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index e1cea8d8ab..858298a7d8 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1325,7 +1325,7 @@ } } }, -"revision": "20260427", +"revision": "20260629", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1504,6 +1504,13 @@ "$ref": "SelfManagedCertificate", "description": "If set, defines data of a self-managed certificate." }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "updateTime": { "description": "Output only. The last update timestamp of a Certificate.", "format": "google-datetime", @@ -1596,6 +1603,13 @@ "format": "int32", "type": "integer" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "updateTime": { "description": "Output only. The last update timestamp of a CertificateIssuanceConfig.", "format": "google-datetime", @@ -1638,6 +1652,13 @@ "description": "Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", "type": "string" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "updateTime": { "description": "Output only. The update timestamp of a Certificate Map.", "format": "google-datetime", @@ -1753,6 +1774,13 @@ "description": "Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", "type": "string" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "type": { "description": "Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.", "enum": [ @@ -2443,6 +2471,13 @@ "description": "Optional. Defines a mapping from a trust domain to a TrustStore. This is used for SPIFFE certificate validation.", "type": "object" }, +"tags": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", +"type": "object" +}, "trustStores": { "description": "Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed.", "items": { From 6195a7b6ae8aec3b7b3ab47a330af7acf973a0af Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:47 +0000 Subject: [PATCH 14/50] feat(ces): update the api #### ces:v1 The following keys were deleted: - schemas.AgentTool.properties.rootAgent (Total Keys: 2) The following keys were added: - resources.projects.resources.locations.resources.apps.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.deployments.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.deployments.resources.message.methods.send (Total Keys: 12) - resources.projects.resources.locations.resources.apps.resources.versions.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.versions.resources.message.methods.send (Total Keys: 12) - schemas.ChannelProfile.properties.instagramConfig.$ref (Total Keys: 1) - schemas.ChannelProfile.properties.whatsappConfig.$ref (Total Keys: 1) - schemas.ChannelProfileInstagramConfig (Total Keys: 5) - schemas.ChannelProfileWhatsAppConfig (Total Keys: 5) - schemas.CitationsCitedChunk.properties.requiresAttribution.type (Total Keys: 1) - schemas.Deployment.properties.instagramCredentials.$ref (Total Keys: 1) - schemas.Deployment.properties.whatsappCredentials.$ref (Total Keys: 1) - schemas.ExecuteToolResponse.properties.citations.$ref (Total Keys: 1) - schemas.ExecuteToolResponse.properties.googleSearchSuggestions.$ref (Total Keys: 1) - schemas.InstagramCredentials (Total Keys: 4) - schemas.LfA2aV1APIKeySecurityScheme (Total Keys: 4) - schemas.LfA2aV1AgentCapabilities (Total Keys: 7) - schemas.LfA2aV1AgentCard (Total Keys: 26) - schemas.LfA2aV1AgentExtension (Total Keys: 6) - schemas.LfA2aV1AgentInterface (Total Keys: 5) - schemas.LfA2aV1AgentProvider (Total Keys: 3) - schemas.LfA2aV1AgentSkill (Total Keys: 14) - schemas.LfA2aV1AuthorizationCodeOAuthFlow (Total Keys: 5) - schemas.LfA2aV1ClientCredentialsOAuthFlow (Total Keys: 4) - schemas.LfA2aV1DeviceCodeOAuthFlow (Total Keys: 4) - schemas.LfA2aV1HTTPAuthSecurityScheme (Total Keys: 4) - schemas.LfA2aV1ImplicitOAuthFlow (Total Keys: 4) - schemas.LfA2aV1MutualTlsSecurityScheme (Total Keys: 2) - schemas.LfA2aV1OAuth2SecurityScheme (Total Keys: 3) - schemas.LfA2aV1OAuthFlows (Total Keys: 9) - schemas.LfA2aV1OpenIdConnectSecurityScheme (Total Keys: 2) - schemas.LfA2aV1PasswordOAuthFlow (Total Keys: 4) - schemas.LfA2aV1SecurityRequirement (Total Keys: 4) - schemas.LfA2aV1SecurityScheme (Total Keys: 7) - schemas.LfA2aV1StringList (Total Keys: 4) - schemas.LoggingSettings.properties.unredactedBigqueryExportSettings.$ref (Total Keys: 1) - schemas.SessionOutput.properties.context (Total Keys: 3) - schemas.SynthesizeSpeechConfig.properties.instruction.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.model.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.voiceSampleGcsUri.type (Total Keys: 1) - schemas.Toolset.properties.timeout (Total Keys: 2) - schemas.WhatsAppCredentials (Total Keys: 7) #### ces:v1beta The following keys were deleted: - schemas.AgentTool.properties.rootAgent (Total Keys: 2) The following keys were added: - resources.projects.resources.locations.resources.apps.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.deployments.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.deployments.resources.message.methods.send (Total Keys: 12) - resources.projects.resources.locations.resources.apps.resources.evaluations.resources.results.methods.runEvaluationResultMetrics (Total Keys: 12) - resources.projects.resources.locations.resources.apps.resources.versions.methods.getExtendedAgentCard (Total Keys: 11) - resources.projects.resources.locations.resources.apps.resources.versions.resources.message.methods.send (Total Keys: 12) - schemas.ChannelProfile.properties.instagramConfig.$ref (Total Keys: 1) - schemas.ChannelProfile.properties.whatsappConfig.$ref (Total Keys: 1) - schemas.ChannelProfileInstagramConfig (Total Keys: 5) - schemas.ChannelProfileWhatsAppConfig (Total Keys: 5) - schemas.CitationsCitedChunk.properties.requiresAttribution.type (Total Keys: 1) - schemas.Deployment.properties.instagramCredentials.$ref (Total Keys: 1) - schemas.Deployment.properties.whatsappCredentials.$ref (Total Keys: 1) - schemas.EvaluationGoldenExpectation.properties.comparisonType.type (Total Keys: 1) - schemas.EvaluationGoldenExpectation.properties.noToolCalls.type (Total Keys: 1) - schemas.EvaluationRunCachingSettings (Total Keys: 3) - schemas.EvaluationRunProgress.properties.cancelledCount (Total Keys: 3) - schemas.EvaluationScenario.properties.scenarioExecutionMode.type (Total Keys: 1) - schemas.EvaluationSettings.properties.evaluationRunCachingSettings.$ref (Total Keys: 1) - schemas.EvaluationSettings.properties.scenarioExecutionMode.type (Total Keys: 1) - schemas.ExecuteToolResponse.properties.citations.$ref (Total Keys: 1) - schemas.ExecuteToolResponse.properties.googleSearchSuggestions.$ref (Total Keys: 1) - schemas.GenerateAppResourceRequest.properties.appVersionContext.$ref (Total Keys: 1) - schemas.GenerateAppResourceRequestAppVersionContext (Total Keys: 4) - schemas.GenerateAppResourceRequestQualityReportGenerationConfig.properties.algorithm.type (Total Keys: 1) - schemas.GenerateEvaluationRequest.properties.evaluationType.type (Total Keys: 1) - schemas.InstagramCredentials (Total Keys: 4) - schemas.LfA2aV1APIKeySecurityScheme (Total Keys: 4) - schemas.LfA2aV1AgentCapabilities (Total Keys: 7) - schemas.LfA2aV1AgentCard (Total Keys: 26) - schemas.LfA2aV1AgentExtension (Total Keys: 6) - schemas.LfA2aV1AgentInterface (Total Keys: 5) - schemas.LfA2aV1AgentProvider (Total Keys: 3) - schemas.LfA2aV1AgentSkill (Total Keys: 14) - schemas.LfA2aV1AuthorizationCodeOAuthFlow (Total Keys: 5) - schemas.LfA2aV1ClientCredentialsOAuthFlow (Total Keys: 4) - schemas.LfA2aV1DeviceCodeOAuthFlow (Total Keys: 4) - schemas.LfA2aV1HTTPAuthSecurityScheme (Total Keys: 4) - schemas.LfA2aV1ImplicitOAuthFlow (Total Keys: 4) - schemas.LfA2aV1MutualTlsSecurityScheme (Total Keys: 2) - schemas.LfA2aV1OAuth2SecurityScheme (Total Keys: 3) - schemas.LfA2aV1OAuthFlows (Total Keys: 9) - schemas.LfA2aV1OpenIdConnectSecurityScheme (Total Keys: 2) - schemas.LfA2aV1PasswordOAuthFlow (Total Keys: 4) - schemas.LfA2aV1SecurityRequirement (Total Keys: 4) - schemas.LfA2aV1SecurityScheme (Total Keys: 7) - schemas.LfA2aV1StringList (Total Keys: 4) - schemas.LoggingSettings.properties.unredactedBigqueryExportSettings.$ref (Total Keys: 1) - schemas.RunEvaluationRequest.properties.evaluationRunCachingSettings.$ref (Total Keys: 1) - schemas.RunEvaluationResultMetricsRequest (Total Keys: 2) - schemas.RunEvaluationResultMetricsResponse (Total Keys: 4) - schemas.SessionOutput.properties.context (Total Keys: 3) - schemas.SynthesizeSpeechConfig.properties.instruction.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.model.type (Total Keys: 1) - schemas.SynthesizeSpeechConfig.properties.voiceSampleGcsUri.type (Total Keys: 1) - schemas.Toolset.properties.timeout (Total Keys: 2) - schemas.WhatsAppCredentials (Total Keys: 7) --- ...1.projects.locations.apps.deployments.html | 335 +++++ ...ts.locations.apps.deployments.message.html | 285 +++++ docs/dyn/ces_v1.projects.locations.apps.html | 315 ++++- ...s_v1.projects.locations.apps.sessions.html | 12 + .../ces_v1.projects.locations.apps.tools.html | 6 - ...s_v1.projects.locations.apps.toolsets.html | 7 +- ...s_v1.projects.locations.apps.versions.html | 283 ++++- ...jects.locations.apps.versions.message.html | 285 +++++ ...projects.locations.apps.conversations.html | 1 + ...a.projects.locations.apps.deployments.html | 335 +++++ ...ts.locations.apps.deployments.message.html | 285 +++++ ...rojects.locations.apps.evaluationRuns.html | 2 + ...a.projects.locations.apps.evaluations.html | 66 +- ...ts.locations.apps.evaluations.results.html | 48 + .../ces_v1beta.projects.locations.apps.html | 345 +++++- ...ocations.apps.scheduledEvaluationRuns.html | 18 + ...beta.projects.locations.apps.sessions.html | 12 + ..._v1beta.projects.locations.apps.tools.html | 6 - ...beta.projects.locations.apps.toolsets.html | 7 +- ...beta.projects.locations.apps.versions.html | 299 ++++- ...jects.locations.apps.versions.message.html | 285 +++++ .../discovery_cache/documents/ces.v1.json | 986 ++++++++++++++- .../discovery_cache/documents/ces.v1beta.json | 1095 ++++++++++++++++- 23 files changed, 5179 insertions(+), 139 deletions(-) create mode 100644 docs/dyn/ces_v1.projects.locations.apps.deployments.message.html create mode 100644 docs/dyn/ces_v1.projects.locations.apps.versions.message.html create mode 100644 docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html create mode 100644 docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.html index 48d0bf1cf9..ca69ea6abc 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.html @@ -74,6 +74,11 @@

Gemini Enterprise for Customer Experience API . projects . locations . apps . deployments

Instance Methods

+

+ message() +

+

Returns the message Resource.

+

close()

Close httplib2 connections.

@@ -86,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified deployment.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists deployments in the given app.

@@ -116,6 +124,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -134,6 +148,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -150,8 +172,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } deploymentId: string, 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. @@ -169,6 +203,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -187,6 +227,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -203,8 +251,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } @@ -247,6 +307,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -265,6 +331,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -281,8 +355,191 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, +} + + +
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
 }
@@ -311,6 +568,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -329,6 +592,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -345,8 +616,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -382,6 +665,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -400,6 +689,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -416,8 +713,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } updateMask: string, Optional. The list of fields to update. @@ -435,6 +744,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -453,6 +768,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -469,8 +792,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html new file mode 100644 index 0000000000..5a98faefce --- /dev/null +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . deployments . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # 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.
+    "returnImmediately": True or False, # 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.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # 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).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `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. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `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. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `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. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `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.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `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. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 1a291b4fc0..73882f3e94 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -147,6 +147,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified app.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

importApp(parent, body=None, x__xgafv=None)

Imports the specified app.

@@ -187,13 +190,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -215,6 +221,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -233,6 +245,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -314,6 +334,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -538,6 +563,27 @@

Method Details

An object of the form: { # Response message for ToolService.ExecuteTool. + "citations": { # Citations associated with the agent response. # Citations that provide the source information for the tool's execution. + "citedChunks": [ # List of cited pieces of information. + { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. + "text": "A String", # Text used for citation. + "title": "A String", # Title of the cited document. + "uri": "A String", # URI used for citation. + }, + ], + }, + "googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution. + "htmls": [ # 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)`. + "A String", + ], + "webSearchQueries": [ # List of queries used to perform the google search along with the search result URIs forming the search suggestions. + { # Represents a single web search query and its associated search uri. + "query": "A String", # The search query text. + "uri": "A String", # The URI to the Google Search results page for the query. + }, + ], + }, "response": { # 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. "a_key": "", # Properties of the object. }, @@ -620,13 +666,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -648,6 +697,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -666,6 +721,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -747,6 +810,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -852,6 +920,177 @@

Method Details

} +
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
+}
+
+
importApp(parent, body=None, x__xgafv=None)
Imports the specified app.
@@ -931,13 +1170,16 @@ 

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -959,6 +1201,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -977,6 +1225,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1058,6 +1314,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -1202,13 +1463,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -1230,6 +1494,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -1248,6 +1518,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1329,6 +1607,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -1452,13 +1735,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -1480,6 +1766,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -1498,6 +1790,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1579,6 +1879,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index c92f2cf6c0..5d9dbd1fe7 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -270,12 +270,18 @@

Method Details

"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. "citedChunks": [ # List of cited pieces of information. { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. "text": "A String", # Text used for citation. "title": "A String", # Title of the cited document. "uri": "A String", # URI used for citation. }, ], }, + "context": [ # Context messages for external supervision guardrails. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], "diagnosticInfo": { # Contains execution details during the processing. # 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. "messages": [ # List of the messages that happened during the processing. { # A message within a conversation. @@ -539,12 +545,18 @@

Method Details

"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. "citedChunks": [ # List of cited pieces of information. { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. "text": "A String", # Text used for citation. "title": "A String", # Title of the cited document. "uri": "A String", # URI used for citation. }, ], }, + "context": [ # Context messages for external supervision guardrails. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], "diagnosticInfo": { # Contains execution details during the processing. # 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. "messages": [ # List of the messages that happened during the processing. { # A message within a conversation. diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html index 0b8c21dc97..fde8204b47 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html @@ -115,7 +115,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -631,7 +630,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1173,7 +1171,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1702,7 +1699,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2235,7 +2231,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2751,7 +2746,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html index 68534ad20d..f49f77da43 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html @@ -311,6 +311,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -527,6 +528,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -769,6 +771,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -998,6 +1001,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1231,6 +1235,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1447,6 +1452,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1488,7 +1494,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index cad1bc4cb7..8ac6f35ee2 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -74,6 +74,11 @@

Gemini Enterprise for Customer Experience API . projects . locations . apps . versions

Instance Methods

+

+ message() +

+

Returns the message Resource.

+

close()

Close httplib2 connections.

@@ -86,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified app version.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all app versions in the given app.

@@ -246,13 +254,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -274,6 +285,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -292,6 +309,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -373,6 +398,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -653,7 +683,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1354,6 +1383,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1511,13 +1541,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -1539,6 +1572,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -1557,6 +1596,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1638,6 +1685,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -1918,7 +1970,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2619,6 +2670,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -2801,13 +2853,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -2829,6 +2884,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -2847,6 +2908,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -2928,6 +2997,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -3208,7 +3282,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -3909,6 +3982,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -3922,6 +3996,177 @@

Method Details

}
+
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all app versions in the given app.
@@ -4078,13 +4323,16 @@ 

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -4106,6 +4354,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -4124,6 +4378,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -4205,6 +4467,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -4485,7 +4752,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -5186,6 +5452,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.message.html b/docs/dyn/ces_v1.projects.locations.apps.versions.message.html new file mode 100644 index 0000000000..67aa7b60c8 --- /dev/null +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . versions . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # 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.
+    "returnImmediately": True or False, # 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.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # 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).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `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. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `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. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `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. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `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.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `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. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index e6d551d7e2..e835ae9a52 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -180,6 +180,7 @@

Method Details

The object takes the form of: { # Request message for EvaluationService.GenerateEvaluation. + "evaluationType": "A String", # Optional. The type of evaluation to generate. Defaults to GOLDEN if unspecified. "source": "A String", # Optional. Indicate the source of the conversation. If not set, all sources will be searched. } diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html index 914627e064..8e5ee443f6 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html @@ -74,6 +74,11 @@

Gemini Enterprise for Customer Experience API . projects . locations . apps . deployments

Instance Methods

+

+ message() +

+

Returns the message Resource.

+

close()

Close httplib2 connections.

@@ -86,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified deployment.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists deployments in the given app.

@@ -116,6 +124,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -134,6 +148,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -150,8 +172,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } deploymentId: string, 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. @@ -169,6 +203,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -187,6 +227,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -203,8 +251,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }
@@ -247,6 +307,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -265,6 +331,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -281,8 +355,191 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, +} + + +
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
 }
@@ -311,6 +568,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -329,6 +592,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -345,8 +616,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. @@ -382,6 +665,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -400,6 +689,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -416,8 +713,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } updateMask: string, Optional. The list of fields to update. @@ -435,6 +744,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -453,6 +768,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "createTime": "A String", # Output only. Timestamp when this deployment was created. "displayName": "A String", # Required. Display name of the deployment. @@ -469,8 +792,20 @@

Method Details

], }, }, + "instagramCredentials": { # Ephemeral Meta credentials for Instagram native integration. # Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + }, "name": "A String", # Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` "updateTime": "A String", # Output only. Timestamp when this deployment was last updated. + "whatsappCredentials": { # Ephemeral Meta credentials for WhatsApp native integration. # Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. + "authCode": "A String", # Required. The Meta auth code provided by the embedded signup flow. + "businessAccountId": "A String", # Required. The Business Account ID to use for the phone number. + "conversationProfileId": "A String", # Optional. The Conversation Profile ID to use for the deployment. + "phoneNumber": "A String", # Required. The phone number to register with WhatsApp. + "pin": "A String", # Required. The 6-digit PIN created by the user for two-step verification. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, } diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html new file mode 100644 index 0000000000..9d1d391a86 --- /dev/null +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . deployments . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # 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.
+    "returnImmediately": True or False, # 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.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # 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).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `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. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `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. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `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. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `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.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `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. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html index 98d9e46d85..58f76393c4 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluationRuns.html @@ -320,6 +320,7 @@

Method Details

}, ], "progress": { # The progress of the evaluation run. # Output only. The progress of the evaluation run. + "cancelledCount": 42, # Output only. Number of evaluation results that were cancelled. (EvaluationResult.execution_state is CANCELLED). "completedCount": 42, # Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED). "errorCount": 42, # Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR). "failedCount": 42, # Output only. Number of completed evaluation results with an outcome of FAIL. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is FAIL). @@ -477,6 +478,7 @@

Method Details

}, ], "progress": { # The progress of the evaluation run. # Output only. The progress of the evaluation run. + "cancelledCount": 42, # Output only. Number of evaluation results that were cancelled. (EvaluationResult.execution_state is CANCELLED). "completedCount": 42, # Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED). "errorCount": 42, # Output only. Number of evaluation results that failed to execute. (EvaluationResult.execution_state is ERROR). "failedCount": 42, # Output only. Number of completed evaluation results with an outcome of FAIL. (EvaluationResult.execution_state is COMPLETED and EvaluationResult.evaluation_status is FAIL). diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index 60549d12de..b911119215 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -246,7 +246,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -333,6 +333,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -348,6 +349,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -567,6 +569,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -582,6 +585,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -1154,6 +1158,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -1169,6 +1174,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -1605,10 +1611,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. @@ -1847,7 +1854,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -1934,6 +1941,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -1949,6 +1957,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -2168,6 +2177,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -2183,6 +2193,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -2755,6 +2766,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -2770,6 +2782,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -3206,10 +3219,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. @@ -3524,7 +3538,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -3611,6 +3625,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -3626,6 +3641,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -3845,6 +3861,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -3860,6 +3877,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -4432,6 +4450,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -4447,6 +4466,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -4883,10 +4903,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. @@ -5140,7 +5161,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -5227,6 +5248,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -5242,6 +5264,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -5461,6 +5484,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -5476,6 +5500,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -6048,6 +6073,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -6063,6 +6089,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -6499,10 +6526,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. @@ -6759,7 +6787,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -6846,6 +6874,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -6861,6 +6890,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -7080,6 +7110,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -7095,6 +7126,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -7667,6 +7699,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -7682,6 +7715,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -8118,10 +8152,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. @@ -8360,7 +8395,7 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the replayed conversation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "turns": [ # Required. The golden turns required to replay a golden conversation. + "turns": [ # Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100. { # A golden turn defines a single turn in a golden conversation. "hallucinationMetricBehaviorOverride": "A String", # Optional. Override for turn-level hallucination metric behavior. "rootSpan": { # A span is a unit of work or a single operation during the request processing. # 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. @@ -8447,6 +8482,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -8462,6 +8498,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -8681,6 +8718,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -8696,6 +8734,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -9268,6 +9307,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -9283,6 +9323,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -9719,10 +9760,11 @@

Method Details

"evaluationExpectations": [ # Optional. The evaluation expectations to evaluate the conversation produced by the simulation against. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}` "A String", ], - "maxTurns": 42, # Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete. + "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. "scenarioExpectations": [ # Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation. { # The expectation to evaluate the conversation produced by the simulation. "agentResponse": { # A message within a conversation. # Optional. The agent response to be evaluated. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index 1506eec291..733a5a3813 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -92,6 +92,9 @@

Instance Methods

list_next()

Retrieves the next page of results.

+

+ runEvaluationResultMetrics(evaluationResultId, body=None, x__xgafv=None)

+

Runs metrics on an existing evaluation result.

Method Details

close() @@ -320,6 +323,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -335,6 +339,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -928,6 +933,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the agent. "targetAgent": "A String", # 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}` }, + "comparisonType": "A String", # Optional. The comparison type to use for the expectation check. "expectationLevelMetricsThresholdsOverride": { # Expectation level metrics thresholds. # Optional. Overrides metrics at the step level. "toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. }, @@ -943,6 +949,7 @@

Method Details

"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` }, }, + "noToolCalls": True or False, # Optional. Check that no tools were called during this turn. "note": "A String", # Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., "Check_Payment_Tool_Called". "skipEvaluation": True or False, # Optional. If set to true, this specific expectation will not be evaluated. "toolCall": { # Request for the client or the agent to execute the specified tool. # Optional. Check that a specific tool was called with the parameters. @@ -1391,4 +1398,45 @@

Method Details

+
+ runEvaluationResultMetrics(evaluationResultId, body=None, x__xgafv=None) +
Runs metrics on an existing evaluation result.
+
+Args:
+  evaluationResultId: string, Required. The evaluation result to run metrics for. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for EvaluationService.RunEvaluationResultMetrics.
+}
+
+  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.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index 8657932d4e..e1b058547c 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -175,6 +175,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified app.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

importApp(parent, body=None, x__xgafv=None)

Imports the specified app.

@@ -224,13 +227,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -252,6 +258,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -270,6 +282,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -319,6 +339,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -344,6 +367,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -391,6 +415,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -615,6 +644,27 @@

Method Details

An object of the form: { # Response message for ToolService.ExecuteTool. + "citations": { # Citations associated with the agent response. # Citations that provide the source information for the tool's execution. + "citedChunks": [ # List of cited pieces of information. + { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. + "text": "A String", # Text used for citation. + "title": "A String", # Title of the cited document. + "uri": "A String", # URI used for citation. + }, + ], + }, + "googleSearchSuggestions": { # Search suggestions from Google Search Tool. # The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution. + "htmls": [ # 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)`. + "A String", + ], + "webSearchQueries": [ # List of queries used to perform the google search along with the search result URIs forming the search suggestions. + { # Represents a single web search query and its associated search uri. + "query": "A String", # The search query text. + "uri": "A String", # The URI to the Google Search results page for the query. + }, + ], + }, "response": { # 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. "a_key": "", # Properties of the object. }, @@ -814,6 +864,10 @@

Method Details

"gcsLocation": "A String", # 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": True or False, # Optional. Whether to generate the evaluations for the app. If true, the provided context will be used to generate the evaluations data. }, + "appVersionContext": { # The app version context specifying the base snapshot and target agent. # The app version context specifying the base snapshot and target agent. + "agentResourceName": "A String", # The resource name of the target agent to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` + "appVersion": "A String", # The resource name of the app version to be used by the LLM assistant. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` + }, "evaluationGenerationConfig": { # The configuration to be used to generate the evaluations. # Optional. The configuration to be used to generate the evaluations. "datasetId": "A String", # Optional. The insights dataset to be used to fetch conversation data for generating the evaluations. Format: `projects/{project}/locations/{location}/datasets/{dataset}`. }, @@ -846,6 +900,7 @@

Method Details

}, }, "qualityReportGenerationConfig": { # The configuration to be used for quality report generation. # Optional. The configuration to be used for quality report generation. + "algorithm": "A String", # Optional. The loss attribution algorithm to use. "evaluationRun": "A String", # Required. The evaluation run used to inform quality report analysis. }, "refineInstructions": [ # Optional. List of refine instructions to be used to refine the resource. @@ -861,7 +916,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1583,6 +1637,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1646,13 +1701,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -1674,6 +1732,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -1692,6 +1756,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1741,6 +1813,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -1766,6 +1841,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -1813,6 +1889,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -1918,6 +1999,177 @@

Method Details

} +
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
+}
+
+
importApp(parent, body=None, x__xgafv=None)
Imports the specified app.
@@ -2048,13 +2300,16 @@ 

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -2076,6 +2331,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -2094,6 +2355,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -2143,6 +2412,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -2168,6 +2440,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -2215,6 +2488,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -2359,13 +2637,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -2387,6 +2668,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -2405,6 +2692,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -2454,6 +2749,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -2479,6 +2777,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -2526,6 +2825,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -2649,13 +2953,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -2677,6 +2984,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -2695,6 +3008,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -2744,6 +3065,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -2769,6 +3093,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -2816,6 +3141,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -3048,6 +3378,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html b/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html index 97a57c6f28..0e62c4bb0a 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.scheduledEvaluationRuns.html @@ -139,6 +139,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], @@ -213,6 +216,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], @@ -312,6 +318,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], @@ -399,6 +408,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], @@ -490,6 +502,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], @@ -564,6 +579,9 @@

Method Details

}, "displayName": "A String", # Optional. The display name of the evaluation run. "evaluationDataset": "A String", # Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}` + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "evaluations": [ # Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}` "A String", ], diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index dc5da4701d..1db1fcf8e9 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -270,12 +270,18 @@

Method Details

"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. "citedChunks": [ # List of cited pieces of information. { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. "text": "A String", # Text used for citation. "title": "A String", # Title of the cited document. "uri": "A String", # URI used for citation. }, ], }, + "context": [ # Context messages for external supervision guardrails. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], "diagnosticInfo": { # Contains execution details during the processing. # 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. "messages": [ # List of the messages that happened during the processing. { # A message within a conversation. @@ -539,12 +545,18 @@

Method Details

"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text. "citedChunks": [ # List of cited pieces of information. { # Piece of cited information. + "requiresAttribution": True or False, # Whether this citation requires attribution to be shown to the end users. "text": "A String", # Text used for citation. "title": "A String", # Title of the cited document. "uri": "A String", # URI used for citation. }, ], }, + "context": [ # Context messages for external supervision guardrails. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], "diagnosticInfo": { # Contains execution details during the processing. # 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. "messages": [ # List of the messages that happened during the processing. { # A message within a conversation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html index 256b01a495..f330574dbc 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html @@ -115,7 +115,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -631,7 +630,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1173,7 +1171,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1702,7 +1699,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2235,7 +2231,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2751,7 +2746,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html index 747e2560bb..9e78b66089 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html @@ -311,6 +311,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -527,6 +528,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -769,6 +771,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -998,6 +1001,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1231,6 +1235,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1447,6 +1452,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1488,7 +1494,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 3dab947b2d..07fd96ee32 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -74,6 +74,11 @@

Gemini Enterprise for Customer Experience API . projects . locations . apps . versions

Instance Methods

+

+ message() +

+

Returns the message Resource.

+

close()

Close httplib2 connections.

@@ -86,6 +91,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of the specified app version.

+

+ getExtendedAgentCard(tenant, x__xgafv=None)

+

Gets the extended agent card for the authenticated agent.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists all app versions in the given app.

@@ -246,13 +254,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -274,6 +285,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -292,6 +309,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -341,6 +366,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -366,6 +394,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -413,6 +442,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -693,7 +727,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -1394,6 +1427,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -1551,13 +1585,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -1579,6 +1616,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -1597,6 +1640,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -1646,6 +1697,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -1671,6 +1725,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -1718,6 +1773,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -1998,7 +2058,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -2699,6 +2758,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -2881,13 +2941,16 @@

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -2909,6 +2972,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -2927,6 +2996,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -2976,6 +3053,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -3001,6 +3081,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -3048,6 +3129,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -3328,7 +3414,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -4029,6 +4114,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. @@ -4042,6 +4128,177 @@

Method Details

}
+
+ getExtendedAgentCard(tenant, x__xgafv=None) +
Gets the extended agent card for the authenticated agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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
+  "capabilities": { # Defines optional capabilities supported by an agent. # Required. A2A Capability set supported by the agent.
+    "extendedAgentCard": True or False, # Indicates if the agent supports providing an extended agent card when authenticated.
+    "extensions": [ # A list of protocol extensions supported by the agent.
+      { # A declaration of a protocol extension supported by an Agent.
+        "description": "A String", # A human-readable description of how this agent uses the extension.
+        "params": { # Optional. Extension-specific configuration parameters.
+          "a_key": "", # Properties of the object.
+        },
+        "required": True or False, # If true, the client must understand and comply with the extension's requirements.
+        "uri": "A String", # The unique URI identifying the extension.
+      },
+    ],
+    "pushNotifications": True or False, # Indicates if the agent supports sending push notifications for asynchronous task updates.
+    "streaming": True or False, # Indicates if the agent supports streaming responses.
+  },
+  "defaultInputModes": [ # 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.
+    "A String",
+  ],
+  "defaultOutputModes": [ # Required. The media types supported as outputs from this agent.
+    "A String",
+  ],
+  "description": "A String", # 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."
+  "documentationUrl": "A String", # A URL providing additional documentation about the agent.
+  "iconUrl": "A String", # Optional. A URL to an icon for the agent.
+  "name": "A String", # Required. A human readable name for the agent. Example: "Recipe Agent"
+  "provider": { # Represents the service provider of an agent. # The service provider of the agent.
+    "organization": "A String", # Required. The name of the agent provider's organization. Example: "Google"
+    "url": "A String", # Required. A URL for the agent provider's website or relevant documentation. Example: "https://ai.google.dev"
+  },
+  "securityRequirements": [ # Security requirements for contacting the agent.
+    { # Defines the security requirements for an agent.
+      "schemes": { # A map of security schemes to the required scopes.
+        "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+          "list": [ # The individual string values.
+            "A String",
+          ],
+        },
+      },
+    },
+  ],
+  "securitySchemes": { # The security scheme details used for authenticating with this agent.
+    "a_key": { # 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
+      "apiKeySecurityScheme": { # Defines a security scheme using an API key. # API key-based authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "location": "A String", # Required. The location of the API key. Valid values are "query", "header", or "cookie".
+        "name": "A String", # Required. The name of the header, query, or cookie parameter to be used.
+      },
+      "httpAuthSecurityScheme": { # Defines a security scheme using HTTP authentication. # HTTP authentication (Basic, Bearer, etc.).
+        "bearerFormat": "A String", # A hint to the client to identify how the bearer token is formatted (e.g., "JWT"). Primarily for documentation purposes.
+        "description": "A String", # An optional description for the security scheme.
+        "scheme": "A String", # 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.
+      },
+      "mtlsSecurityScheme": { # Defines a security scheme using mTLS authentication. # Mutual TLS authentication.
+        "description": "A String", # An optional description for the security scheme.
+      },
+      "oauth2SecurityScheme": { # Defines a security scheme using OAuth 2.0. # OAuth 2.0 authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "flows": { # Defines the configuration for the supported OAuth 2.0 flows. # Required. An object containing configuration information for the supported OAuth 2.0 flows.
+          "authorizationCode": { # Defines configuration details for the OAuth 2.0 Authorization Code flow. # Configuration for the OAuth Authorization Code flow.
+            "authorizationUrl": "A String", # Required. The authorization URL to be used for this flow.
+            "pkceRequired": True or False, # Indicates if PKCE (RFC 7636) is required for this flow. PKCE should always be used for public clients and is recommended for all clients.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "clientCredentials": { # Defines configuration details for the OAuth 2.0 Client Credentials flow. # Configuration for the OAuth Client Credentials flow.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "deviceCode": { # 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. # Configuration for the OAuth Device Code flow.
+            "deviceAuthorizationUrl": "A String", # Required. The device authorization endpoint URL.
+            "refreshUrl": "A String", # The URL to be used for obtaining refresh tokens.
+            "scopes": { # Required. The available scopes for the OAuth2 security scheme.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # Required. The token URL to be used for this flow.
+          },
+          "implicit": { # Deprecated: Use Authorization Code + PKCE instead. # Deprecated: Use Authorization Code + PKCE instead.
+            "authorizationUrl": "A String", # 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
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+          },
+          "password": { # Deprecated: Use Authorization Code + PKCE or Device Code. # Deprecated: Use Authorization Code + PKCE or Device Code.
+            "refreshUrl": "A String", # 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.
+            "scopes": { # 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.
+              "a_key": "A String",
+            },
+            "tokenUrl": "A String", # 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.
+          },
+        },
+        "oauth2MetadataUrl": "A String", # URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.
+      },
+      "openIdConnectSecurityScheme": { # Defines a security scheme using OpenID Connect. # OpenID Connect authentication.
+        "description": "A String", # An optional description for the security scheme.
+        "openIdConnectUrl": "A String", # Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.
+      },
+    },
+  },
+  "signatures": [ # JSON Web Signatures computed for this `AgentCard`.
+    { # AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+      "header": { # The unprotected JWS header values.
+        "a_key": "", # Properties of the object.
+      },
+      "protected": "A String", # Required. Required. The protected JWS header for the signature. This is always a base64url-encoded JSON object.
+      "signature": "A String", # Required. The computed signature, base64url-encoded.
+    },
+  ],
+  "skills": [ # 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.
+    { # Represents a distinct capability or function that an agent can perform.
+      "description": "A String", # Required. A detailed description of the skill.
+      "examples": [ # Example prompts or scenarios that this skill can handle.
+        "A String",
+      ],
+      "id": "A String", # Required. A unique identifier for the agent's skill.
+      "inputModes": [ # The set of supported input media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "name": "A String", # Required. A human-readable name for the skill.
+      "outputModes": [ # The set of supported output media types for this skill, overriding the agent's defaults.
+        "A String",
+      ],
+      "securityRequirements": [ # Security schemes necessary for this skill.
+        { # Defines the security requirements for an agent.
+          "schemes": { # A map of security schemes to the required scopes.
+            "a_key": { # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
+              "list": [ # The individual string values.
+                "A String",
+              ],
+            },
+          },
+        },
+      ],
+      "tags": [ # Required. A set of keywords describing the skill's capabilities.
+        "A String",
+      ],
+    },
+  ],
+  "supportedInterfaces": [ # Required. Ordered list of supported interfaces. The first entry is preferred.
+    { # 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.
+      "protocolBinding": "A String", # 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`.
+      "protocolVersion": "A String", # Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0"
+      "tenant": "A String", # Tenant ID to be used in the request when calling the agent.
+      "url": "A String", # 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"
+    },
+  ],
+  "version": "A String", # Required. The version of the agent. Example: "1.0.0"
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all app versions in the given app.
@@ -4198,13 +4455,16 @@ 

Method Details

}, "bargeInConfig": { # Configuration for how the user barge-in activities should be handled. # Optional. Configures the agent behavior for the user barge-in activities. "bargeInAwareness": True or False, # 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. - "disableBargeIn": True or False, # Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile. + "disableBargeIn": True or False, # 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. }, "inactivityTimeout": "A String", # 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. "synthesizeSpeechConfigs": { # 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. "a_key": { # Configuration for how the agent response should be synthesized. + "instruction": "A String", # Optional. The instruction used to synthesize speech when using a generative model. + "model": "A String", # Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. "speakingRate": 3.14, # 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. "voice": "A String", # 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. + "voiceSampleGcsUri": "A String", # Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. 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. }, }, }, @@ -4226,6 +4486,12 @@

Method Details

"channelType": "A String", # Optional. The type of the channel profile. "disableBargeInControl": True or False, # 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. "disableDtmf": True or False, # Optional. Whether to disable DTMF (dual-tone multi-frequency). + "instagramConfig": { # Configuration specific to Instagram deployments. # Optional. Configuration specific to Instagram deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "instagramAccountId": "A String", # Required. The Instagram Account ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + }, "noiseSuppressionLevel": "A String", # Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". "personaProperty": { # Represents the persona property of a channel. # Optional. The persona property of the channel profile. "persona": "A String", # Optional. The persona of the channel. @@ -4244,6 +4510,14 @@

Method Details

"theme": "A String", # Optional. The theme of the web widget. "webWidgetTitle": "A String", # Optional. The title of the web widget. }, + "whatsappConfig": { # Configuration specific to WhatsApp deployments. # Optional. Configuration specific to WhatsApp deployments. + "description": "A String", # Output only. The description of the Meta business page or profile. + "displayName": "A String", # Output only. The fetched Meta business page name. + "phoneNumber": "A String", # Optional. The phone number in E.164 format. + "phoneNumberId": "A String", # Required. The Meta phone number ID. + "thumbnailUrl": "A String", # Output only. The fetched Meta business profile thumbnail URL. + "wabaId": "A String", # Required. The WhatsApp Business Account ID. + }, }, "deploymentCount": 42, # Output only. Number of deployments in the app. "description": "A String", # Optional. Human-readable description of the app. @@ -4293,6 +4567,9 @@

Method Details

}, ], "evaluationSettings": { # Settings for evaluation. # Optional. The evaluation settings for the app. + "evaluationRunCachingSettings": { # Settings for evaluation run caching. # Optional. The caching settings to use for the evaluation run. + "runCachingMode": "A String", # Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN. + }, "goldenEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for golden evaluations. "goldenRunMethod": "A String", # Optional. The default method used to run golden evaluations. This will be used if no golden_run_method is specified in the RunEvaluationRequest. "metricsConfig": { # Configures the metrics for an evaluation. # Optional. Configures the default metrics for evaluations. @@ -4318,6 +4595,7 @@

Method Details

}, "scenarioConversationInitiator": "A String", # Optional. Who starts the conversation in a scenario evaluation. "scenarioEvaluationToolCallBehaviour": "A String", # Optional. Configures the default tool call behaviour for scenario evaluations. + "scenarioExecutionMode": "A String", # Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED. }, "globalInstruction": "A String", # 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. "guardrails": [ # Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` @@ -4365,6 +4643,11 @@

Method Details

"gcsBucket": "A String", # 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`. "gcsPathPrefix": "A String", # 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. }, + "unredactedBigqueryExportSettings": { # Settings to describe the BigQuery export behaviors for the app. # Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. + "dataset": "A String", # Optional. The BigQuery **dataset ID** to export the data to. + "enabled": True or False, # Optional. Indicates whether the BigQuery export is enabled. + "project": "A String", # 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`. + }, }, "metadata": { # Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. "a_key": "A String", @@ -4645,7 +4928,6 @@

Method Details

"agent": "A String", # Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` "description": "A String", # Optional. Description of the tool's purpose. "name": "A String", # Required. The name of the agent tool. - "rootAgent": "A String", # Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` }, "clientFunction": { # 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. # Optional. The client function. "description": "A String", # Optional. The function description. @@ -5346,6 +5628,7 @@

Method Details

}, "url": "A String", # 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. }, + "timeout": "A String", # 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. "toolFakeConfig": { # Configuration for tool behavior in fake mode. # Optional. Configuration for tools behavior in fake mode. "codeBlock": { # A code block to be executed instead of a real tool call. # Optional. Code block which will be executed instead of a real tool call. "pythonCode": "A String", # 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) -> Optional[dict[str, Any]]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: If the function returns None, the real tool will be invoked instead. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html new file mode 100644 index 0000000000..d66bbec946 --- /dev/null +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.message.html @@ -0,0 +1,285 @@ + + + +

Gemini Enterprise for Customer Experience API . projects . locations . apps . versions . message

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ send(tenant, body=None, x__xgafv=None)

+

Sends a message to an agent.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ send(tenant, body=None, x__xgafv=None) +
Sends a message to an agent.
+
+Args:
+  tenant: string, Optional. Tenant ID, provided as a path parameter. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a request for the `SendMessage` method.
+  "configuration": { # Configuration of a send message request. # Configuration for the send request.
+    "acceptedOutputModes": [ # A list of media types the client is prepared to accept for response parts. Agents SHOULD use this to tailor their output.
+      "A String",
+    ],
+    "historyLength": 42, # 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.
+    "returnImmediately": True or False, # 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.
+    "taskPushNotificationConfig": { # A container associating a push notification configuration with a specific task. # Configuration for the agent to send push notifications for task updates. Task id should be empty when sending this configuration in a `SendMessage` request.
+      "authentication": { # Defines authentication details, used for push notifications. # Authentication information required to send the notification.
+        "credentials": "A String", # Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).
+        "scheme": "A String", # 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).
+      },
+      "id": "A String", # The push notification configuration details. A unique identifier (e.g. UUID) for this push notification configuration.
+      "taskId": "A String", # The ID of the task this configuration is associated with.
+      "tenant": "A String", # Optional. Tenant ID.
+      "token": "A String", # A token unique for this task or session.
+      "url": "A String", # Required. The URL where the notification should be sent.
+    },
+  },
+  "message": { # `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. # Required. The message to send to the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "metadata": { # A flexible key-value map for passing additional context or parameters.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the response for the `SendMessage` method.
+  "message": { # `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. # A message from the agent.
+    "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+    "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+      "A String",
+    ],
+    "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+    "metadata": { # Optional. Any metadata to provide along with the message.
+      "a_key": "", # Properties of the object.
+    },
+    "parts": [ # Required. Parts is the container of the message content.
+      { # `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).
+        "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+        "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+        "mediaType": "A String", # 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.
+        "metadata": { # Optional. metadata associated with this part.
+          "a_key": "", # Properties of the object.
+        },
+        "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+        "text": "A String", # The string content of the `text` part.
+        "url": "A String", # A `url` pointing to the file's content.
+      },
+    ],
+    "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+      "A String",
+    ],
+    "role": "A String", # Required. Identifies the sender of the message.
+    "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+  },
+  "task": { # `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. # The task created or updated by the message.
+    "artifacts": [ # A set of output artifacts for a `Task`.
+      { # Artifacts represent task outputs.
+        "artifactId": "A String", # Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.
+        "description": "A String", # Optional. A human readable description of the artifact.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Artifact.
+          "A String",
+        ],
+        "metadata": { # Optional. Metadata included with the artifact.
+          "a_key": "", # Properties of the object.
+        },
+        "name": "A String", # A human readable name for the artifact.
+        "parts": [ # Required. The content of the artifact. Must contain at least one part.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+      },
+    ],
+    "contextId": "A String", # Unique identifier (e.g. UUID) for the contextual collection of interactions (tasks and messages).
+    "history": [ # protolint:disable REPEATED_FIELD_NAMES_PLURALIZED The history of interactions from a `Task`.
+      { # `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.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+    ],
+    "id": "A String", # Required. Unique identifier (e.g. UUID) for the task, generated by the server for a new task.
+    "metadata": { # protolint:enable REPEATED_FIELD_NAMES_PLURALIZED A key/value object to store custom metadata about a task.
+      "a_key": "", # Properties of the object.
+    },
+    "status": { # A container for the status of a task # Required. The current status of a `Task`, including `state` and a `message`.
+      "message": { # `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. # A message associated with the status.
+        "contextId": "A String", # Optional. The context id of the message. If set, the message will be associated with the given context.
+        "extensions": [ # The URIs of extensions that are present or contributed to this Message.
+          "A String",
+        ],
+        "messageId": "A String", # Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.
+        "metadata": { # Optional. Any metadata to provide along with the message.
+          "a_key": "", # Properties of the object.
+        },
+        "parts": [ # Required. Parts is the container of the message content.
+          { # `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).
+            "data": "", # Arbitrary structured `data` as a JSON value (object, array, string, number, boolean, or null).
+            "filename": "A String", # An optional `filename` for the file (e.g., "document.pdf").
+            "mediaType": "A String", # 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.
+            "metadata": { # Optional. metadata associated with this part.
+              "a_key": "", # Properties of the object.
+            },
+            "raw": "A String", # The `raw` byte content of a file. In JSON serialization, this is encoded as a base64 string.
+            "text": "A String", # The string content of the `text` part.
+            "url": "A String", # A `url` pointing to the file's content.
+          },
+        ],
+        "referenceTaskIds": [ # A list of task IDs that this message references for additional context.
+          "A String",
+        ],
+        "role": "A String", # Required. Identifies the sender of the message.
+        "taskId": "A String", # Optional. The task id of the message. If set, the message will be associated with the given task.
+      },
+      "state": "A String", # Required. The current state of this task.
+      "timestamp": "A String", # ISO 8601 Timestamp when the status was recorded. Example: "2023-10-27T10:00:00Z"
+    },
+  },
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index 9fe777e139..f60e33c191 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -351,6 +351,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "importApp": { "description": "Imports the specified app.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps:importApp", @@ -1051,6 +1077,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.deployments.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists deployments in the given app.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", @@ -1128,6 +1180,41 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.deployments.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "examples": { @@ -2099,6 +2186,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.versions.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists all app versions in the given app.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", @@ -2175,6 +2288,41 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.versions.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } } } @@ -2316,7 +2464,7 @@ } } }, -"revision": "20260513", +"revision": "20260708", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -2703,11 +2851,6 @@ "name": { "description": "Required. The name of the agent tool.", "type": "string" -}, -"rootAgent": { -"deprecated": true, -"description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", -"type": "string" } }, "type": "object" @@ -3131,7 +3274,7 @@ }, "disableBargeIn": { "deprecated": true, -"description": "Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile.", +"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" } }, @@ -3322,8 +3465,11 @@ "TWILIO", "GOOGLE_TELEPHONY_PLATFORM", "CONTACT_CENTER_AS_A_SERVICE", +"CONTACT_CENTER_AS_A_SERVICE_CHAT", "FIVE9", -"CONTACT_CENTER_INTEGRATION" +"CONTACT_CENTER_INTEGRATION", +"WHATSAPP", +"INSTAGRAM" ], "enumDescriptions": [ "Unknown channel type.", @@ -3332,8 +3478,11 @@ "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." +"Third party contact center integration channel.", +"WhatsApp channel.", +"Instagram channel." ], "type": "string" }, @@ -3345,6 +3494,10 @@ "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, +"instagramConfig": { +"$ref": "ChannelProfileInstagramConfig", +"description": "Optional. Configuration specific to Instagram deployments." +}, "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" @@ -3360,6 +3513,36 @@ "webWidgetConfig": { "$ref": "ChannelProfileWebWidgetConfig", "description": "Optional. The configuration for the web widget." +}, +"whatsappConfig": { +"$ref": "ChannelProfileWhatsAppConfig", +"description": "Optional. Configuration specific to WhatsApp deployments." +} +}, +"type": "object" +}, +"ChannelProfileInstagramConfig": { +"description": "Configuration specific to Instagram deployments.", +"id": "ChannelProfileInstagramConfig", +"properties": { +"description": { +"description": "Output only. The description of the Meta business page or profile.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The fetched Meta business page name.", +"readOnly": true, +"type": "string" +}, +"instagramAccountId": { +"description": "Required. The Instagram Account ID.", +"type": "string" +}, +"thumbnailUrl": { +"description": "Output only. The fetched Meta business profile thumbnail URL.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -3458,6 +3641,40 @@ }, "type": "object" }, +"ChannelProfileWhatsAppConfig": { +"description": "Configuration specific to WhatsApp deployments.", +"id": "ChannelProfileWhatsAppConfig", +"properties": { +"description": { +"description": "Output only. The description of the Meta business page or profile.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The fetched Meta business page name.", +"readOnly": true, +"type": "string" +}, +"phoneNumber": { +"description": "Optional. The phone number in E.164 format.", +"type": "string" +}, +"phoneNumberId": { +"description": "Required. The Meta phone number ID.", +"type": "string" +}, +"thumbnailUrl": { +"description": "Output only. The fetched Meta business profile thumbnail URL.", +"readOnly": true, +"type": "string" +}, +"wabaId": { +"description": "Required. The WhatsApp Business Account ID.", +"type": "string" +} +}, +"type": "object" +}, "Chunk": { "description": "A chunk of content within a message.", "id": "Chunk", @@ -3535,6 +3752,10 @@ "description": "Piece of cited information.", "id": "CitationsCitedChunk", "properties": { +"requiresAttribution": { +"description": "Whether this citation requires attribution to be shown to the end users.", +"type": "boolean" +}, "text": { "description": "Text used for citation.", "type": "string" @@ -4268,6 +4489,10 @@ "$ref": "ExperimentConfig", "description": "Optional. Experiment configuration for the deployment." }, +"instagramCredentials": { +"$ref": "InstagramCredentials", +"description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile." +}, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" @@ -4277,6 +4502,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"whatsappCredentials": { +"$ref": "WhatsAppCredentials", +"description": "Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile." } }, "type": "object" @@ -4682,6 +4911,14 @@ "description": "Response message for ToolService.ExecuteTool.", "id": "ExecuteToolResponse", "properties": { +"citations": { +"$ref": "Citations", +"description": "Citations that provide the source information for the tool's execution." +}, +"googleSearchSuggestions": { +"$ref": "GoogleSearchSuggestions", +"description": "The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution." +}, "response": { "additionalProperties": { "description": "Properties of the object.", @@ -4735,10 +4972,10 @@ ], "enumDescriptions": [ "Unspecified state.", -"Pending state. Experiment is pending and not valid.", +"Deprecated: This state is no longer used.", "Running state. Experiment is running and valid.", -"Done state. Experiment is done and no longer valid.", -"Expired state. Experiment is expired and no longer valid." +"Deprecated: This state is no longer used.", +"Deprecated: This state is no longer used." ], "type": "string" }, @@ -5359,6 +5596,21 @@ }, "type": "object" }, +"InstagramCredentials": { +"description": "Ephemeral Meta credentials for Instagram native integration.", +"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" +} +}, +"type": "object" +}, "LanguageSettings": { "description": "Language settings of the app.", "id": "LanguageSettings", @@ -5386,90 +5638,480 @@ }, "type": "object" }, -"LfA2aV1Artifact": { -"description": "Artifacts represent task outputs.", -"id": "LfA2aV1Artifact", +"LfA2aV1APIKeySecurityScheme": { +"description": "Defines a security scheme using an API key.", +"id": "LfA2aV1APIKeySecurityScheme", "properties": { -"artifactId": { -"description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", -"type": "string" -}, "description": { -"description": "Optional. A human readable description of the artifact.", +"description": "An optional description for the security scheme.", "type": "string" }, -"extensions": { -"description": "The URIs of extensions that are present or contributed to this Artifact.", -"items": { +"location": { +"description": "Required. The location of the API key. Valid values are \"query\", \"header\", or \"cookie\".", "type": "string" }, -"type": "array" -}, -"metadata": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"name": { +"description": "Required. The name of the header, query, or cookie parameter to be used.", +"type": "string" +} }, -"description": "Optional. Metadata included with the artifact.", "type": "object" }, -"name": { -"description": "A human readable name for the artifact.", -"type": "string" +"LfA2aV1AgentCapabilities": { +"description": "Defines optional capabilities supported by an agent.", +"id": "LfA2aV1AgentCapabilities", +"properties": { +"extendedAgentCard": { +"description": "Indicates if the agent supports providing an extended agent card when authenticated.", +"type": "boolean" }, -"parts": { -"description": "Required. The content of the artifact. Must contain at least one part.", +"extensions": { +"description": "A list of protocol extensions supported by the agent.", "items": { -"$ref": "LfA2aV1Part" +"$ref": "LfA2aV1AgentExtension" }, "type": "array" -} -}, -"type": "object" }, -"LfA2aV1AuthenticationInfo": { -"description": "Defines authentication details, used for push notifications.", -"id": "LfA2aV1AuthenticationInfo", -"properties": { -"credentials": { -"description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", -"type": "string" +"pushNotifications": { +"description": "Indicates if the agent supports sending push notifications for asynchronous task updates.", +"type": "boolean" }, -"scheme": { -"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).", -"type": "string" +"streaming": { +"description": "Indicates if the agent supports streaming responses.", +"type": "boolean" } }, "type": "object" }, -"LfA2aV1Message": { -"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.", -"id": "LfA2aV1Message", +"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", +"id": "LfA2aV1AgentCard", "properties": { -"contextId": { -"description": "Optional. The context id of the message. If set, the message will be associated with the given context.", +"capabilities": { +"$ref": "LfA2aV1AgentCapabilities", +"description": "Required. A2A Capability set supported by the agent." +}, +"defaultInputModes": { +"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.", +"items": { "type": "string" }, -"extensions": { -"description": "The URIs of extensions that are present or contributed to this Message.", +"type": "array" +}, +"defaultOutputModes": { +"description": "Required. The media types supported as outputs from this agent.", "items": { "type": "string" }, "type": "array" }, -"messageId": { -"description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", +"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" }, -"metadata": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"documentationUrl": { +"description": "A URL providing additional documentation about the agent.", +"type": "string" }, -"description": "Optional. Any metadata to provide along with the message.", -"type": "object" +"iconUrl": { +"description": "Optional. A URL to an icon for the agent.", +"type": "string" }, -"parts": { +"name": { +"description": "Required. A human readable name for the agent. Example: \"Recipe Agent\"", +"type": "string" +}, +"provider": { +"$ref": "LfA2aV1AgentProvider", +"description": "The service provider of the agent." +}, +"securityRequirements": { +"description": "Security requirements for contacting the agent.", +"items": { +"$ref": "LfA2aV1SecurityRequirement" +}, +"type": "array" +}, +"securitySchemes": { +"additionalProperties": { +"$ref": "LfA2aV1SecurityScheme" +}, +"description": "The security scheme details used for authenticating with this agent.", +"type": "object" +}, +"signatures": { +"description": "JSON Web Signatures computed for this `AgentCard`.", +"items": { +"$ref": "LfA2aV1AgentCardSignature" +}, +"type": "array" +}, +"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.", +"items": { +"$ref": "LfA2aV1AgentSkill" +}, +"type": "array" +}, +"supportedInterfaces": { +"description": "Required. Ordered list of supported interfaces. The first entry is preferred.", +"items": { +"$ref": "LfA2aV1AgentInterface" +}, +"type": "array" +}, +"version": { +"description": "Required. The version of the agent. Example: \"1.0.0\"", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AgentCardSignature": { +"description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).", +"id": "LfA2aV1AgentCardSignature", +"properties": { +"header": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The unprotected JWS header values.", +"type": "object" +}, +"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" +}, +"LfA2aV1AgentExtension": { +"description": "A declaration of a protocol extension supported by an Agent.", +"id": "LfA2aV1AgentExtension", +"properties": { +"description": { +"description": "A human-readable description of how this agent uses the extension.", +"type": "string" +}, +"params": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Extension-specific configuration parameters.", +"type": "object" +}, +"required": { +"description": "If true, the client must understand and comply with the extension's requirements.", +"type": "boolean" +}, +"uri": { +"description": "The unique URI identifying the extension.", +"type": "string" +} +}, +"type": "object" +}, +"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.", +"id": "LfA2aV1AgentInterface", +"properties": { +"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" +}, +"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" +}, +"tenant": { +"description": "Tenant ID to be used in the request when calling the agent.", +"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" +} +}, +"type": "object" +}, +"LfA2aV1AgentProvider": { +"description": "Represents the service provider of an agent.", +"id": "LfA2aV1AgentProvider", +"properties": { +"organization": { +"description": "Required. The name of the agent provider's organization. Example: \"Google\"", +"type": "string" +}, +"url": { +"description": "Required. A URL for the agent provider's website or relevant documentation. Example: \"https://ai.google.dev\"", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AgentSkill": { +"description": "Represents a distinct capability or function that an agent can perform.", +"id": "LfA2aV1AgentSkill", +"properties": { +"description": { +"description": "Required. A detailed description of the skill.", +"type": "string" +}, +"examples": { +"description": "Example prompts or scenarios that this skill can handle.", +"items": { +"type": "string" +}, +"type": "array" +}, +"id": { +"description": "Required. A unique identifier for the agent's skill.", +"type": "string" +}, +"inputModes": { +"description": "The set of supported input media types for this skill, overriding the agent's defaults.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Required. A human-readable name for the skill.", +"type": "string" +}, +"outputModes": { +"description": "The set of supported output media types for this skill, overriding the agent's defaults.", +"items": { +"type": "string" +}, +"type": "array" +}, +"securityRequirements": { +"description": "Security schemes necessary for this skill.", +"items": { +"$ref": "LfA2aV1SecurityRequirement" +}, +"type": "array" +}, +"tags": { +"description": "Required. A set of keywords describing the skill's capabilities.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"LfA2aV1Artifact": { +"description": "Artifacts represent task outputs.", +"id": "LfA2aV1Artifact", +"properties": { +"artifactId": { +"description": "Required. Unique identifier (e.g. UUID) for the artifact. It must be unique within a task.", +"type": "string" +}, +"description": { +"description": "Optional. A human readable description of the artifact.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Artifact.", +"items": { +"type": "string" +}, +"type": "array" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Metadata included with the artifact.", +"type": "object" +}, +"name": { +"description": "A human readable name for the artifact.", +"type": "string" +}, +"parts": { +"description": "Required. The content of the artifact. Must contain at least one part.", +"items": { +"$ref": "LfA2aV1Part" +}, +"type": "array" +} +}, +"type": "object" +}, +"LfA2aV1AuthenticationInfo": { +"description": "Defines authentication details, used for push notifications.", +"id": "LfA2aV1AuthenticationInfo", +"properties": { +"credentials": { +"description": "Push Notification credentials. Format depends on the scheme (e.g., token for Bearer).", +"type": "string" +}, +"scheme": { +"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).", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AuthorizationCodeOAuthFlow": { +"description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", +"id": "LfA2aV1AuthorizationCodeOAuthFlow", +"properties": { +"authorizationUrl": { +"description": "Required. The authorization URL to be used for this flow.", +"type": "string" +}, +"pkceRequired": { +"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.", +"type": "boolean" +}, +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1ClientCredentialsOAuthFlow": { +"description": "Defines configuration details for the OAuth 2.0 Client Credentials flow.", +"id": "LfA2aV1ClientCredentialsOAuthFlow", +"properties": { +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"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.", +"id": "LfA2aV1DeviceCodeOAuthFlow", +"properties": { +"deviceAuthorizationUrl": { +"description": "Required. The device authorization endpoint URL.", +"type": "string" +}, +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1HTTPAuthSecurityScheme": { +"description": "Defines a security scheme using HTTP authentication.", +"id": "LfA2aV1HTTPAuthSecurityScheme", +"properties": { +"bearerFormat": { +"description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\"). Primarily for documentation purposes.", +"type": "string" +}, +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"scheme": { +"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.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1ImplicitOAuthFlow": { +"description": "Deprecated: Use Authorization Code + PKCE instead.", +"id": "LfA2aV1ImplicitOAuthFlow", +"properties": { +"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" +}, +"scopes": { +"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.", +"type": "object" +} +}, +"type": "object" +}, +"LfA2aV1Message": { +"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.", +"id": "LfA2aV1Message", +"properties": { +"contextId": { +"description": "Optional. The context id of the message. If set, the message will be associated with the given context.", +"type": "string" +}, +"extensions": { +"description": "The URIs of extensions that are present or contributed to this Message.", +"items": { +"type": "string" +}, +"type": "array" +}, +"messageId": { +"description": "Required. The unique identifier (e.g. UUID) of the message. This is created by the message creator.", +"type": "string" +}, +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Any metadata to provide along with the message.", +"type": "object" +}, +"parts": { "description": "Required. Parts is the container of the message content.", "items": { "$ref": "LfA2aV1Part" @@ -5504,6 +6146,80 @@ }, "type": "object" }, +"LfA2aV1MutualTlsSecurityScheme": { +"description": "Defines a security scheme using mTLS authentication.", +"id": "LfA2aV1MutualTlsSecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1OAuth2SecurityScheme": { +"description": "Defines a security scheme using OAuth 2.0.", +"id": "LfA2aV1OAuth2SecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"flows": { +"$ref": "LfA2aV1OAuthFlows", +"description": "Required. An object containing configuration information for the supported OAuth 2.0 flows." +}, +"oauth2MetadataUrl": { +"description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1OAuthFlows": { +"description": "Defines the configuration for the supported OAuth 2.0 flows.", +"id": "LfA2aV1OAuthFlows", +"properties": { +"authorizationCode": { +"$ref": "LfA2aV1AuthorizationCodeOAuthFlow", +"description": "Configuration for the OAuth Authorization Code flow." +}, +"clientCredentials": { +"$ref": "LfA2aV1ClientCredentialsOAuthFlow", +"description": "Configuration for the OAuth Client Credentials flow." +}, +"deviceCode": { +"$ref": "LfA2aV1DeviceCodeOAuthFlow", +"description": "Configuration for the OAuth Device Code flow." +}, +"implicit": { +"$ref": "LfA2aV1ImplicitOAuthFlow", +"deprecated": true, +"description": "Deprecated: Use Authorization Code + PKCE instead." +}, +"password": { +"$ref": "LfA2aV1PasswordOAuthFlow", +"deprecated": true, +"description": "Deprecated: Use Authorization Code + PKCE or Device Code." +} +}, +"type": "object" +}, +"LfA2aV1OpenIdConnectSecurityScheme": { +"description": "Defines a security scheme using OpenID Connect.", +"id": "LfA2aV1OpenIdConnectSecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"openIdConnectUrl": { +"description": "Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.", +"type": "string" +} +}, +"type": "object" +}, "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).", "id": "LfA2aV1Part", @@ -5544,6 +6260,69 @@ }, "type": "object" }, +"LfA2aV1PasswordOAuthFlow": { +"description": "Deprecated: Use Authorization Code + PKCE or Device Code.", +"id": "LfA2aV1PasswordOAuthFlow", +"properties": { +"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": { +"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.", +"type": "object" +}, +"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" +} +}, +"type": "object" +}, +"LfA2aV1SecurityRequirement": { +"description": "Defines the security requirements for an agent.", +"id": "LfA2aV1SecurityRequirement", +"properties": { +"schemes": { +"additionalProperties": { +"$ref": "LfA2aV1StringList" +}, +"description": "A map of security schemes to the required scopes.", +"type": "object" +} +}, +"type": "object" +}, +"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", +"id": "LfA2aV1SecurityScheme", +"properties": { +"apiKeySecurityScheme": { +"$ref": "LfA2aV1APIKeySecurityScheme", +"description": "API key-based authentication." +}, +"httpAuthSecurityScheme": { +"$ref": "LfA2aV1HTTPAuthSecurityScheme", +"description": "HTTP authentication (Basic, Bearer, etc.)." +}, +"mtlsSecurityScheme": { +"$ref": "LfA2aV1MutualTlsSecurityScheme", +"description": "Mutual TLS authentication." +}, +"oauth2SecurityScheme": { +"$ref": "LfA2aV1OAuth2SecurityScheme", +"description": "OAuth 2.0 authentication." +}, +"openIdConnectSecurityScheme": { +"$ref": "LfA2aV1OpenIdConnectSecurityScheme", +"description": "OpenID Connect authentication." +} +}, +"type": "object" +}, "LfA2aV1SendMessageConfiguration": { "description": "Configuration of a send message request.", "id": "LfA2aV1SendMessageConfiguration", @@ -5609,6 +6388,20 @@ }, "type": "object" }, +"LfA2aV1StringList": { +"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.", +"id": "LfA2aV1StringList", +"properties": { +"list": { +"description": "The individual string values.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "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.", "id": "LfA2aV1Task", @@ -6022,6 +6815,10 @@ "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." +}, +"unredactedBigqueryExportSettings": { +"$ref": "BigQueryExportSettings", +"description": "Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled." } }, "type": "object" @@ -6998,6 +7795,17 @@ "$ref": "Citations", "description": "Citations that provide the source information for the agent's generated text." }, +"context": { +"description": "Context messages for external supervision guardrails.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, "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." @@ -7134,6 +7942,14 @@ "description": "Configuration for how the agent response should be synthesized.", "id": "SynthesizeSpeechConfig", "properties": { +"instruction": { +"description": "Optional. The instruction used to synthesize speech when using a generative model.", +"type": "string" +}, +"model": { +"description": "Optional. The model used to synthesize audio. Currently supported values: - \"gemini-3.1-flash-tts-preview\" If empty, Chirp3-HD is used.", +"type": "string" +}, "speakingRate": { "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", @@ -7142,6 +7958,10 @@ "voice": { "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.", "type": "string" +}, +"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. 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" @@ -7470,6 +8290,11 @@ "$ref": "OpenApiToolset", "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema." }, +"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" +}, "toolFakeConfig": { "$ref": "ToolFakeConfig", "description": "Optional. Configuration for tools behavior in fake mode." @@ -7656,6 +8481,37 @@ }, "type": "object" }, +"WhatsAppCredentials": { +"description": "Ephemeral Meta credentials for WhatsApp native integration.", +"id": "WhatsAppCredentials", +"properties": { +"authCode": { +"description": "Required. The Meta auth code provided by the embedded signup flow.", +"type": "string" +}, +"businessAccountId": { +"description": "Required. The Business Account ID to use for the phone number.", +"type": "string" +}, +"conversationProfileId": { +"description": "Optional. The Conversation Profile ID to use for the deployment.", +"type": "string" +}, +"phoneNumber": { +"description": "Required. The phone number to register with WhatsApp.", +"type": "string" +}, +"pin": { +"description": "Required. The 6-digit PIN created by the user for two-step verification.", +"type": "string" +}, +"wabaId": { +"description": "Required. The WhatsApp Business Account ID.", +"type": "string" +} +}, +"type": "object" +}, "WidgetTool": { "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", diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index a736e1ebb3..dce9578d67 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -441,6 +441,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "importApp": { "description": "Imports the specified app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps:importApp", @@ -1257,6 +1283,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.deployments.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists deployments in the given app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments", @@ -1334,6 +1386,41 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.deployments.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "evaluationDatasets": { @@ -2207,6 +2294,35 @@ "https://www.googleapis.com/auth/ces", "https://www.googleapis.com/auth/cloud-platform" ] +}, +"runEvaluationResultMetrics": { +"description": "Runs metrics on an existing evaluation result.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/evaluations/{evaluationsId}/results/{resultsId}:runEvaluationResultMetrics", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.evaluations.results.runEvaluationResultMetrics", +"parameterOrder": [ +"evaluationResultId" +], +"parameters": { +"evaluationResultId": { +"description": "Required. The evaluation result to run metrics for. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/evaluations/[^/]+/results/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+evaluationResultId}:runEvaluationResultMetrics", +"request": { +"$ref": "RunEvaluationResultMetricsRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -3358,6 +3474,32 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getExtendedAgentCard": { +"description": "Gets the extended agent card for the authenticated agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/extendedAgentCard", +"httpMethod": "GET", +"id": "ces.projects.locations.apps.versions.getExtendedAgentCard", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/extendedAgentCard", +"response": { +"$ref": "LfA2aV1AgentCard" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists all app versions in the given app.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions", @@ -3434,6 +3576,41 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"message": { +"methods": { +"send": { +"description": "Sends a message to an agent.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:send", +"httpMethod": "POST", +"id": "ces.projects.locations.apps.versions.message.send", +"parameterOrder": [ +"tenant" +], +"parameters": { +"tenant": { +"description": "Optional. Tenant ID, provided as a path parameter.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+tenant}/message:send", +"request": { +"$ref": "LfA2aV1SendMessageRequest" +}, +"response": { +"$ref": "LfA2aV1SendMessageResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/ces", +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } } } @@ -3575,7 +3752,7 @@ } } }, -"revision": "20260513", +"revision": "20260708", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3962,11 +4139,6 @@ "name": { "description": "Required. The name of the agent tool.", "type": "string" -}, -"rootAgent": { -"deprecated": true, -"description": "Optional. Deprecated: Use `agent` instead. The resource name of the root agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}`", -"type": "string" } }, "type": "object" @@ -4622,7 +4794,7 @@ }, "disableBargeIn": { "deprecated": true, -"description": "Optional. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. Deprecated: `disable_barge_in` is deprecated in favor of `disable_barge_in_control` in ChannelProfile.", +"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" } }, @@ -4841,8 +5013,11 @@ "TWILIO", "GOOGLE_TELEPHONY_PLATFORM", "CONTACT_CENTER_AS_A_SERVICE", +"CONTACT_CENTER_AS_A_SERVICE_CHAT", "FIVE9", -"CONTACT_CENTER_INTEGRATION" +"CONTACT_CENTER_INTEGRATION", +"WHATSAPP", +"INSTAGRAM" ], "enumDescriptions": [ "Unknown channel type.", @@ -4851,8 +5026,11 @@ "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." +"Third party contact center integration channel.", +"WhatsApp channel.", +"Instagram channel." ], "type": "string" }, @@ -4864,6 +5042,10 @@ "description": "Optional. Whether to disable DTMF (dual-tone multi-frequency).", "type": "boolean" }, +"instagramConfig": { +"$ref": "ChannelProfileInstagramConfig", +"description": "Optional. Configuration specific to Instagram deployments." +}, "noiseSuppressionLevel": { "description": "Optional. The noise suppression level of the channel profile. Available values are \"low\", \"moderate\", \"high\", \"very_high\".", "type": "string" @@ -4879,6 +5061,36 @@ "webWidgetConfig": { "$ref": "ChannelProfileWebWidgetConfig", "description": "Optional. The configuration for the web widget." +}, +"whatsappConfig": { +"$ref": "ChannelProfileWhatsAppConfig", +"description": "Optional. Configuration specific to WhatsApp deployments." +} +}, +"type": "object" +}, +"ChannelProfileInstagramConfig": { +"description": "Configuration specific to Instagram deployments.", +"id": "ChannelProfileInstagramConfig", +"properties": { +"description": { +"description": "Output only. The description of the Meta business page or profile.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The fetched Meta business page name.", +"readOnly": true, +"type": "string" +}, +"instagramAccountId": { +"description": "Required. The Instagram Account ID.", +"type": "string" +}, +"thumbnailUrl": { +"description": "Output only. The fetched Meta business profile thumbnail URL.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -4977,6 +5189,40 @@ }, "type": "object" }, +"ChannelProfileWhatsAppConfig": { +"description": "Configuration specific to WhatsApp deployments.", +"id": "ChannelProfileWhatsAppConfig", +"properties": { +"description": { +"description": "Output only. The description of the Meta business page or profile.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The fetched Meta business page name.", +"readOnly": true, +"type": "string" +}, +"phoneNumber": { +"description": "Optional. The phone number in E.164 format.", +"type": "string" +}, +"phoneNumberId": { +"description": "Required. The Meta phone number ID.", +"type": "string" +}, +"thumbnailUrl": { +"description": "Output only. The fetched Meta business profile thumbnail URL.", +"readOnly": true, +"type": "string" +}, +"wabaId": { +"description": "Required. The WhatsApp Business Account ID.", +"type": "string" +} +}, +"type": "object" +}, "Chunk": { "description": "A chunk of content within a message.", "id": "Chunk", @@ -5054,6 +5300,10 @@ "description": "Piece of cited information.", "id": "CitationsCitedChunk", "properties": { +"requiresAttribution": { +"description": "Whether this citation requires attribution to be shown to the end users.", +"type": "boolean" +}, "text": { "description": "Text used for citation.", "type": "string" @@ -5793,6 +6043,10 @@ "$ref": "ExperimentConfig", "description": "Optional. Experiment configuration for the deployment." }, +"instagramCredentials": { +"$ref": "InstagramCredentials", +"description": "Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile." +}, "name": { "description": "Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}`", "type": "string" @@ -5802,6 +6056,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"whatsappCredentials": { +"$ref": "WhatsAppCredentials", +"description": "Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile." } }, "type": "object" @@ -6279,7 +6537,7 @@ "type": "array" }, "turns": { -"description": "Required. The golden turns required to replay a golden conversation.", +"description": "Required. The golden turns required to replay a golden conversation. The maximum number of allowed turns is 100.", "items": { "$ref": "EvaluationGoldenTurn" }, @@ -6308,6 +6566,22 @@ "$ref": "AgentTransfer", "description": "Optional. Check that the agent transferred the conversation to a different agent." }, +"comparisonType": { +"description": "Optional. The comparison type to use for the expectation check.", +"enum": [ +"COMPARISON_TYPE_UNSPECIFIED", +"EQUALS", +"CONTAINS", +"SEMANTIC_SIMILARITY" +], +"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" +}, "expectationLevelMetricsThresholdsOverride": { "$ref": "EvaluationMetricsThresholdsGoldenEvaluationMetricsThresholdsExpectationLevelMetricsThresholds", "description": "Optional. Overrides metrics at the step level." @@ -6316,6 +6590,10 @@ "$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." }, +"noToolCalls": { +"description": "Optional. Check that no tools were called during this turn.", +"type": "boolean" +}, "note": { "description": "Optional. A note for this requirement, useful in reporting when specific checks fail. E.g., \"Check_Payment_Tool_Called\".", "type": "string" @@ -6763,15 +7041,19 @@ "description": "Output only. The state of the evaluation result execution.", "enum": [ "EXECUTION_STATE_UNSPECIFIED", +"QUEUED", "RUNNING", "COMPLETED", -"ERROR" +"ERROR", +"CANCELLED" ], "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 failed due to an internal error.", +"Evaluation result execution was cancelled." ], "readOnly": true, "type": "string" @@ -7637,15 +7919,19 @@ "description": "Output only. The state of the evaluation run.", "enum": [ "EVALUATION_RUN_STATE_UNSPECIFIED", +"QUEUED", "RUNNING", "COMPLETED", -"ERROR" +"ERROR", +"CANCELLED" ], "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." +"The evaluation run has an error.", +"Evaluation run was cancelled." ], "readOnly": true, "type": "string" @@ -7653,6 +7939,27 @@ }, "type": "object" }, +"EvaluationRunCachingSettings": { +"description": "Settings for evaluation run caching.", +"id": "EvaluationRunCachingSettings", +"properties": { +"runCachingMode": { +"description": "Optional. The caching mode to use for the evaluation run. If not set, default to FORCE_RUN.", +"enum": [ +"EVALUATION_RUN_CACHING_MODE_UNSPECIFIED", +"FORCE_RUN", +"SKIP_IF_UNCHANGED" +], +"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." +], +"type": "string" +} +}, +"type": "object" +}, "EvaluationRunEvaluationRunSummary": { "description": "Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.", "id": "EvaluationRunEvaluationRunSummary", @@ -7682,6 +7989,12 @@ "description": "The progress of the evaluation run.", "id": "EvaluationRunProgress", "properties": { +"cancelledCount": { +"description": "Output only. Number of evaluation results that were cancelled. (EvaluationResult.execution_state is CANCELLED).", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "completedCount": { "description": "Output only. Number of evaluation results that finished successfully. (EvaluationResult.execution_state is COMPLETED).", "format": "int32", @@ -7727,7 +8040,7 @@ "type": "array" }, "maxTurns": { -"description": "Optional. The maximum number of turns to simulate. If not specified, the simulation will continue until the task is complete.", +"description": "Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100.", "format": "int32", "type": "integer" }, @@ -7738,6 +8051,20 @@ }, "type": "array" }, +"scenarioExecutionMode": { +"description": "Optional. The execution mode for scenario evaluations.", +"enum": [ +"SCENARIO_EXECUTION_MODE_UNSPECIFIED", +"QUALITY_OPTIMIZED", +"SPEED_OPTIMIZED" +], +"enumDescriptions": [ +"Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", +"Quality optimized mode.", +"Speed optimized mode." +], +"type": "string" +}, "scenarioExpectations": { "description": "Required. The ScenarioExpectations to evaluate the conversation produced by the user simulation.", "items": { @@ -7847,6 +8174,10 @@ "description": "Settings for evaluation.", "id": "EvaluationSettings", "properties": { +"evaluationRunCachingSettings": { +"$ref": "EvaluationRunCachingSettings", +"description": "Optional. The caching settings to use for the evaluation run." +}, "goldenEvaluationToolCallBehaviour": { "description": "Optional. Configures the default tool call behaviour for golden evaluations.", "enum": [ @@ -7906,6 +8237,20 @@ "Use fake tool calls." ], "type": "string" +}, +"scenarioExecutionMode": { +"description": "Optional. The execution mode for scenario evaluations. If not provided, will default to QUALITY_OPTIMIZED.", +"enum": [ +"SCENARIO_EXECUTION_MODE_UNSPECIFIED", +"QUALITY_OPTIMIZED", +"SPEED_OPTIMIZED" +], +"enumDescriptions": [ +"Unspecified execution mode. Defaults to QUALITY_OPTIMIZED.", +"Quality optimized mode.", +"Speed optimized mode." +], +"type": "string" } }, "type": "object" @@ -8038,6 +8383,14 @@ "description": "Response message for ToolService.ExecuteTool.", "id": "ExecuteToolResponse", "properties": { +"citations": { +"$ref": "Citations", +"description": "Citations that provide the source information for the tool's execution." +}, +"googleSearchSuggestions": { +"$ref": "GoogleSearchSuggestions", +"description": "The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution." +}, "response": { "additionalProperties": { "description": "Properties of the object.", @@ -8091,10 +8444,10 @@ ], "enumDescriptions": [ "Unspecified state.", -"Pending state. Experiment is pending and not valid.", +"Deprecated: This state is no longer used.", "Running state. Experiment is running and valid.", -"Done state. Experiment is done and no longer valid.", -"Expired state. Experiment is expired and no longer valid." +"Deprecated: This state is no longer used.", +"Deprecated: This state is no longer used." ], "type": "string" }, @@ -8403,6 +8756,10 @@ "$ref": "GenerateAppResourceRequestAppGenerationConfig", "description": "Optional. The configuration to be used to generate the agents and tools." }, +"appVersionContext": { +"$ref": "GenerateAppResourceRequestAppVersionContext", +"description": "The app version context specifying the base snapshot and target agent." +}, "evaluationGenerationConfig": { "$ref": "GenerateAppResourceRequestEvaluationGenerationConfig", "description": "Optional. The configuration to be used to generate the evaluations." @@ -8471,6 +8828,21 @@ }, "type": "object" }, +"GenerateAppResourceRequestAppVersionContext": { +"description": "The app version context specifying the base snapshot and target agent.", +"id": "GenerateAppResourceRequestAppVersionContext", +"properties": { +"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" +}, +"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" +} +}, +"type": "object" +}, "GenerateAppResourceRequestEvaluationGenerationConfig": { "description": "The configuration to be used to generate the evaluations.", "id": "GenerateAppResourceRequestEvaluationGenerationConfig", @@ -8503,6 +8875,20 @@ "description": "The configuration to be used for quality report generation.", "id": "GenerateAppResourceRequestQualityReportGenerationConfig", "properties": { +"algorithm": { +"description": "Optional. The loss attribution algorithm to use.", +"enum": [ +"LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED", +"APP_CENTRIC", +"AGENT_CENTRIC" +], +"enumDescriptions": [ +"Unspecified.", +"App-centric loss attribution. Treats the app as a single unit.", +"Agent-centric loss attribution. Attributes loss to individual agents." +], +"type": "string" +}, "evaluationRun": { "description": "Required. The evaluation run used to inform quality report analysis.", "type": "string" @@ -8740,9 +9126,23 @@ "description": "Request message for EvaluationService.GenerateEvaluation.", "id": "GenerateEvaluationRequest", "properties": { -"source": { -"deprecated": true, -"description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", +"evaluationType": { +"description": "Optional. The type of evaluation to generate. Defaults to GOLDEN if unspecified.", +"enum": [ +"EVALUATION_TYPE_UNSPECIFIED", +"GOLDEN", +"SCENARIO" +], +"enumDescriptions": [ +"Unspecified type. Defaults to GOLDEN.", +"Golden evaluation.", +"Scenario evaluation." +], +"type": "string" +}, +"source": { +"deprecated": true, +"description": "Optional. Indicate the source of the conversation. If not set, all sources will be searched.", "enum": [ "SOURCE_UNSPECIFIED", "LIVE", @@ -9360,6 +9760,21 @@ }, "type": "object" }, +"InstagramCredentials": { +"description": "Ephemeral Meta credentials for Instagram native integration.", +"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" +} +}, +"type": "object" +}, "LanguageSettings": { "description": "Language settings of the app.", "id": "LanguageSettings", @@ -9546,6 +9961,277 @@ }, "type": "object" }, +"LfA2aV1APIKeySecurityScheme": { +"description": "Defines a security scheme using an API key.", +"id": "LfA2aV1APIKeySecurityScheme", +"properties": { +"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" +}, +"name": { +"description": "Required. The name of the header, query, or cookie parameter to be used.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AgentCapabilities": { +"description": "Defines optional capabilities supported by an agent.", +"id": "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.", +"items": { +"$ref": "LfA2aV1AgentExtension" +}, +"type": "array" +}, +"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" +} +}, +"type": "object" +}, +"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", +"id": "LfA2aV1AgentCard", +"properties": { +"capabilities": { +"$ref": "LfA2aV1AgentCapabilities", +"description": "Required. A2A Capability set supported by the agent." +}, +"defaultInputModes": { +"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.", +"items": { +"type": "string" +}, +"type": "array" +}, +"defaultOutputModes": { +"description": "Required. The media types supported as outputs from this agent.", +"items": { +"type": "string" +}, +"type": "array" +}, +"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" +}, +"documentationUrl": { +"description": "A URL providing additional documentation about the agent.", +"type": "string" +}, +"iconUrl": { +"description": "Optional. A URL to an icon for the agent.", +"type": "string" +}, +"name": { +"description": "Required. A human readable name for the agent. Example: \"Recipe Agent\"", +"type": "string" +}, +"provider": { +"$ref": "LfA2aV1AgentProvider", +"description": "The service provider of the agent." +}, +"securityRequirements": { +"description": "Security requirements for contacting the agent.", +"items": { +"$ref": "LfA2aV1SecurityRequirement" +}, +"type": "array" +}, +"securitySchemes": { +"additionalProperties": { +"$ref": "LfA2aV1SecurityScheme" +}, +"description": "The security scheme details used for authenticating with this agent.", +"type": "object" +}, +"signatures": { +"description": "JSON Web Signatures computed for this `AgentCard`.", +"items": { +"$ref": "LfA2aV1AgentCardSignature" +}, +"type": "array" +}, +"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.", +"items": { +"$ref": "LfA2aV1AgentSkill" +}, +"type": "array" +}, +"supportedInterfaces": { +"description": "Required. Ordered list of supported interfaces. The first entry is preferred.", +"items": { +"$ref": "LfA2aV1AgentInterface" +}, +"type": "array" +}, +"version": { +"description": "Required. The version of the agent. Example: \"1.0.0\"", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AgentCardSignature": { +"description": "AgentCardSignature represents a JWS signature of an AgentCard. This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).", +"id": "LfA2aV1AgentCardSignature", +"properties": { +"header": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The unprotected JWS header values.", +"type": "object" +}, +"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" +}, +"LfA2aV1AgentExtension": { +"description": "A declaration of a protocol extension supported by an Agent.", +"id": "LfA2aV1AgentExtension", +"properties": { +"description": { +"description": "A human-readable description of how this agent uses the extension.", +"type": "string" +}, +"params": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Extension-specific configuration parameters.", +"type": "object" +}, +"required": { +"description": "If true, the client must understand and comply with the extension's requirements.", +"type": "boolean" +}, +"uri": { +"description": "The unique URI identifying the extension.", +"type": "string" +} +}, +"type": "object" +}, +"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.", +"id": "LfA2aV1AgentInterface", +"properties": { +"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" +}, +"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" +}, +"tenant": { +"description": "Tenant ID to be used in the request when calling the agent.", +"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" +} +}, +"type": "object" +}, +"LfA2aV1AgentProvider": { +"description": "Represents the service provider of an agent.", +"id": "LfA2aV1AgentProvider", +"properties": { +"organization": { +"description": "Required. The name of the agent provider's organization. Example: \"Google\"", +"type": "string" +}, +"url": { +"description": "Required. A URL for the agent provider's website or relevant documentation. Example: \"https://ai.google.dev\"", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1AgentSkill": { +"description": "Represents a distinct capability or function that an agent can perform.", +"id": "LfA2aV1AgentSkill", +"properties": { +"description": { +"description": "Required. A detailed description of the skill.", +"type": "string" +}, +"examples": { +"description": "Example prompts or scenarios that this skill can handle.", +"items": { +"type": "string" +}, +"type": "array" +}, +"id": { +"description": "Required. A unique identifier for the agent's skill.", +"type": "string" +}, +"inputModes": { +"description": "The set of supported input media types for this skill, overriding the agent's defaults.", +"items": { +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "Required. A human-readable name for the skill.", +"type": "string" +}, +"outputModes": { +"description": "The set of supported output media types for this skill, overriding the agent's defaults.", +"items": { +"type": "string" +}, +"type": "array" +}, +"securityRequirements": { +"description": "Security schemes necessary for this skill.", +"items": { +"$ref": "LfA2aV1SecurityRequirement" +}, +"type": "array" +}, +"tags": { +"description": "Required. A set of keywords describing the skill's capabilities.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "LfA2aV1Artifact": { "description": "Artifacts represent task outputs.", "id": "LfA2aV1Artifact", @@ -9602,6 +10288,125 @@ }, "type": "object" }, +"LfA2aV1AuthorizationCodeOAuthFlow": { +"description": "Defines configuration details for the OAuth 2.0 Authorization Code flow.", +"id": "LfA2aV1AuthorizationCodeOAuthFlow", +"properties": { +"authorizationUrl": { +"description": "Required. The authorization URL to be used for this flow.", +"type": "string" +}, +"pkceRequired": { +"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.", +"type": "boolean" +}, +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1ClientCredentialsOAuthFlow": { +"description": "Defines configuration details for the OAuth 2.0 Client Credentials flow.", +"id": "LfA2aV1ClientCredentialsOAuthFlow", +"properties": { +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"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.", +"id": "LfA2aV1DeviceCodeOAuthFlow", +"properties": { +"deviceAuthorizationUrl": { +"description": "Required. The device authorization endpoint URL.", +"type": "string" +}, +"refreshUrl": { +"description": "The URL to be used for obtaining refresh tokens.", +"type": "string" +}, +"scopes": { +"additionalProperties": { +"type": "string" +}, +"description": "Required. The available scopes for the OAuth2 security scheme.", +"type": "object" +}, +"tokenUrl": { +"description": "Required. The token URL to be used for this flow.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1HTTPAuthSecurityScheme": { +"description": "Defines a security scheme using HTTP authentication.", +"id": "LfA2aV1HTTPAuthSecurityScheme", +"properties": { +"bearerFormat": { +"description": "A hint to the client to identify how the bearer token is formatted (e.g., \"JWT\"). Primarily for documentation purposes.", +"type": "string" +}, +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"scheme": { +"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.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1ImplicitOAuthFlow": { +"description": "Deprecated: Use Authorization Code + PKCE instead.", +"id": "LfA2aV1ImplicitOAuthFlow", +"properties": { +"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" +}, +"scopes": { +"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.", +"type": "object" +} +}, +"type": "object" +}, "LfA2aV1Message": { "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.", "id": "LfA2aV1Message", @@ -9664,6 +10469,80 @@ }, "type": "object" }, +"LfA2aV1MutualTlsSecurityScheme": { +"description": "Defines a security scheme using mTLS authentication.", +"id": "LfA2aV1MutualTlsSecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1OAuth2SecurityScheme": { +"description": "Defines a security scheme using OAuth 2.0.", +"id": "LfA2aV1OAuth2SecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"flows": { +"$ref": "LfA2aV1OAuthFlows", +"description": "Required. An object containing configuration information for the supported OAuth 2.0 flows." +}, +"oauth2MetadataUrl": { +"description": "URL to the OAuth2 authorization server metadata [RFC 8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required.", +"type": "string" +} +}, +"type": "object" +}, +"LfA2aV1OAuthFlows": { +"description": "Defines the configuration for the supported OAuth 2.0 flows.", +"id": "LfA2aV1OAuthFlows", +"properties": { +"authorizationCode": { +"$ref": "LfA2aV1AuthorizationCodeOAuthFlow", +"description": "Configuration for the OAuth Authorization Code flow." +}, +"clientCredentials": { +"$ref": "LfA2aV1ClientCredentialsOAuthFlow", +"description": "Configuration for the OAuth Client Credentials flow." +}, +"deviceCode": { +"$ref": "LfA2aV1DeviceCodeOAuthFlow", +"description": "Configuration for the OAuth Device Code flow." +}, +"implicit": { +"$ref": "LfA2aV1ImplicitOAuthFlow", +"deprecated": true, +"description": "Deprecated: Use Authorization Code + PKCE instead." +}, +"password": { +"$ref": "LfA2aV1PasswordOAuthFlow", +"deprecated": true, +"description": "Deprecated: Use Authorization Code + PKCE or Device Code." +} +}, +"type": "object" +}, +"LfA2aV1OpenIdConnectSecurityScheme": { +"description": "Defines a security scheme using OpenID Connect.", +"id": "LfA2aV1OpenIdConnectSecurityScheme", +"properties": { +"description": { +"description": "An optional description for the security scheme.", +"type": "string" +}, +"openIdConnectUrl": { +"description": "Required. The [OpenID Connect Discovery URL](https://openid.net/specs/openid-connect-discovery-1_0.html) for the OIDC provider's metadata.", +"type": "string" +} +}, +"type": "object" +}, "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).", "id": "LfA2aV1Part", @@ -9704,6 +10583,69 @@ }, "type": "object" }, +"LfA2aV1PasswordOAuthFlow": { +"description": "Deprecated: Use Authorization Code + PKCE or Device Code.", +"id": "LfA2aV1PasswordOAuthFlow", +"properties": { +"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": { +"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.", +"type": "object" +}, +"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" +} +}, +"type": "object" +}, +"LfA2aV1SecurityRequirement": { +"description": "Defines the security requirements for an agent.", +"id": "LfA2aV1SecurityRequirement", +"properties": { +"schemes": { +"additionalProperties": { +"$ref": "LfA2aV1StringList" +}, +"description": "A map of security schemes to the required scopes.", +"type": "object" +} +}, +"type": "object" +}, +"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", +"id": "LfA2aV1SecurityScheme", +"properties": { +"apiKeySecurityScheme": { +"$ref": "LfA2aV1APIKeySecurityScheme", +"description": "API key-based authentication." +}, +"httpAuthSecurityScheme": { +"$ref": "LfA2aV1HTTPAuthSecurityScheme", +"description": "HTTP authentication (Basic, Bearer, etc.)." +}, +"mtlsSecurityScheme": { +"$ref": "LfA2aV1MutualTlsSecurityScheme", +"description": "Mutual TLS authentication." +}, +"oauth2SecurityScheme": { +"$ref": "LfA2aV1OAuth2SecurityScheme", +"description": "OAuth 2.0 authentication." +}, +"openIdConnectSecurityScheme": { +"$ref": "LfA2aV1OpenIdConnectSecurityScheme", +"description": "OpenID Connect authentication." +} +}, +"type": "object" +}, "LfA2aV1SendMessageConfiguration": { "description": "Configuration of a send message request.", "id": "LfA2aV1SendMessageConfiguration", @@ -9769,6 +10711,20 @@ }, "type": "object" }, +"LfA2aV1StringList": { +"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.", +"id": "LfA2aV1StringList", +"properties": { +"list": { +"description": "The individual string values.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "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.", "id": "LfA2aV1Task", @@ -10290,6 +11246,10 @@ "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." +}, +"unredactedBigqueryExportSettings": { +"$ref": "BigQueryExportSettings", +"description": "Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled." } }, "type": "object" @@ -11070,6 +12030,10 @@ "description": "Optional. An evaluation dataset to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}`", "type": "string" }, +"evaluationRunCachingSettings": { +"$ref": "EvaluationRunCachingSettings", +"description": "Optional. The caching settings to use for the evaluation run." +}, "evaluations": { "description": "Optional. List of evaluations to run. Format: `projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}`", "items": { @@ -11118,6 +12082,36 @@ }, "type": "object" }, +"RunEvaluationResultMetricsRequest": { +"description": "Request message for EvaluationService.RunEvaluationResultMetrics.", +"id": "RunEvaluationResultMetricsRequest", +"properties": {}, +"type": "object" +}, +"RunEvaluationResultMetricsResponse": { +"description": "Response message for EvaluationService.RunEvaluationResultMetrics.", +"id": "RunEvaluationResultMetricsResponse", +"properties": { +"status": { +"description": "Output only. The status of the evaluation result metrics calculation.", +"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." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RunSessionRequest": { "description": "Request message for SessionService.RunSession.", "id": "RunSessionRequest", @@ -11590,6 +12584,17 @@ "$ref": "Citations", "description": "Citations that provide the source information for the agent's generated text." }, +"context": { +"description": "Context messages for external supervision guardrails.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, "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." @@ -11726,6 +12731,14 @@ "description": "Configuration for how the agent response should be synthesized.", "id": "SynthesizeSpeechConfig", "properties": { +"instruction": { +"description": "Optional. The instruction used to synthesize speech when using a generative model.", +"type": "string" +}, +"model": { +"description": "Optional. The model used to synthesize audio. Currently supported values: - \"gemini-3.1-flash-tts-preview\" If empty, Chirp3-HD is used.", +"type": "string" +}, "speakingRate": { "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", @@ -11734,6 +12747,10 @@ "voice": { "description": "Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech.", "type": "string" +}, +"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. 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" @@ -12089,6 +13106,11 @@ "$ref": "OpenApiToolset", "description": "Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema." }, +"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" +}, "toolFakeConfig": { "$ref": "ToolFakeConfig", "description": "Optional. Configuration for tools behavior in fake mode." @@ -12311,6 +13333,37 @@ }, "type": "object" }, +"WhatsAppCredentials": { +"description": "Ephemeral Meta credentials for WhatsApp native integration.", +"id": "WhatsAppCredentials", +"properties": { +"authCode": { +"description": "Required. The Meta auth code provided by the embedded signup flow.", +"type": "string" +}, +"businessAccountId": { +"description": "Required. The Business Account ID to use for the phone number.", +"type": "string" +}, +"conversationProfileId": { +"description": "Optional. The Conversation Profile ID to use for the deployment.", +"type": "string" +}, +"phoneNumber": { +"description": "Required. The phone number to register with WhatsApp.", +"type": "string" +}, +"pin": { +"description": "Required. The 6-digit PIN created by the user for two-step verification.", +"type": "string" +}, +"wabaId": { +"description": "Required. The WhatsApp Business Account ID.", +"type": "string" +} +}, +"type": "object" +}, "WidgetTool": { "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", From 0e92eaf5dd691f58f44462f401fe93e89a11ce18 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:47 +0000 Subject: [PATCH 15/50] feat(chat): update the api #### chat:v1 The following keys were deleted: - resources.users.resources.availability.methods.get (Total Keys: 11) - resources.users.resources.availability.methods.updateAvailability (Total Keys: 15) The following keys were added: - resources.users.resources.availability.methods.get (Total Keys: 11) - resources.users.resources.availability.methods.patch (Total Keys: 15) - schemas.AccessPermissionSetting (Total Keys: 8) - schemas.AccessSettings.properties.accessPermissionSettings.$ref (Total Keys: 1) - schemas.Audience (Total Keys: 3) - schemas.Principal (Total Keys: 3) --- docs/dyn/chat_v1.spaces.html | 242 ++++++++++++- docs/dyn/chat_v1.spaces.messages.html | 160 +++++++++ docs/dyn/chat_v1.spaces.spaceEvents.html | 320 ++++++++++++++++++ docs/dyn/chat_v1.users.availability.html | 12 +- .../discovery_cache/documents/chat.v1.json | 69 +++- 5 files changed, 789 insertions(+), 14 deletions(-) diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 47aa5fa2cf..57f72b6925 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -160,6 +160,26 @@

Method Details

{ # Response message for completing the import process for a space. "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The import mode space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -244,6 +264,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -327,6 +367,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -435,6 +495,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -534,6 +614,26 @@

Method Details

"spaces": [ # List of spaces in the requested (or first) page. { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -640,6 +740,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -734,6 +854,26 @@

Method Details

"spaces": [ # List of spaces in the requested (or first) page. Note: The `permissionSettings` field is not returned in the Space object for list requests. { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -834,6 +974,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -906,7 +1066,7 @@

Method Details

"type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. } - updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` + updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` useAdminAccess: boolean, Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. x__xgafv: string, V1 error format. Allowed values @@ -918,6 +1078,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -1014,6 +1194,26 @@

Method Details

"spaces": [ # Deprecated: Please use the new `results` field instead. A page of the requested spaces. This field will be populated only when `useAdminAccess` is set to `true` and deprecated in favor of the new `results` field. { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -1136,6 +1336,26 @@

Method Details

"requestId": "A String", # Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -1219,6 +1439,26 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index cb29229a0f..dfe3d56bb1 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -3065,6 +3065,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -6107,6 +6127,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -9162,6 +9202,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -12205,6 +12265,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -15253,6 +15333,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -18284,6 +18384,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -21315,6 +21435,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -24346,6 +24486,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 6f3993046e..131e388050 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -3186,6 +3186,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -6212,6 +6232,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -9238,6 +9278,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -12262,6 +12322,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -15284,6 +15364,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -18306,6 +18406,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -18499,6 +18619,26 @@

Method Details

{ # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -18576,6 +18716,26 @@

Method Details

"spaceUpdatedEventData": { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` # Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated` "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -21751,6 +21911,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -24777,6 +24957,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -27803,6 +28003,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -30827,6 +31047,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -33849,6 +34089,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -36871,6 +37131,26 @@

Method Details

}, "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Output only. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output only populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -37064,6 +37344,26 @@

Method Details

{ # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, @@ -37141,6 +37441,26 @@

Method Details

"spaceUpdatedEventData": { # Event payload for an updated space. Event type: `google.workspace.chat.space.v1.updated` # Event payload for a space update. Event type: `google.workspace.chat.space.v1.updated` "space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. + "accessPermissionSettings": { # Access permission settings for a space. # Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request. + "discoverSpaceSetting": { # An access permission setting. # Optional. Access permission setting for discovering the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + "joinSpaceSetting": { # An access permission setting. # Optional. Access permission setting for joining the space. + "principals": [ # Optional. Unordered list. Allowed principals for this permission. + { # A principal representing an entity granted access. + "audience": { # A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). # An audience. + "name": "A String", # The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + }, + }, + ], + }, + }, "accessState": "A String", # Output only. Indicates the access state of the space. "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope. This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). }, diff --git a/docs/dyn/chat_v1.users.availability.html b/docs/dyn/chat_v1.users.availability.html index bc2feef1eb..3922b06c06 100644 --- a/docs/dyn/chat_v1.users.availability.html +++ b/docs/dyn/chat_v1.users.availability.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- getAvailability(name, x__xgafv=None)

+ get(name, x__xgafv=None)

Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`

markAsActive(name, body=None, x__xgafv=None)

@@ -88,9 +88,9 @@

Instance Methods

Marks user as `AWAY` in Google Chat. Sets the user's state to away and is not affected by the user's activity. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`

markAsDoNotDisturb(name, body=None, x__xgafv=None)

-

Marks user as`DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`

+

Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`

- updateAvailability(name, body=None, updateMask=None, x__xgafv=None)

+ patch(name, body=None, updateMask=None, x__xgafv=None)

Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`

Method Details

@@ -99,7 +99,7 @@

Method Details

- getAvailability(name, x__xgafv=None) + get(name, x__xgafv=None)
Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`
 
 Args:
@@ -237,7 +237,7 @@ 

Method Details

markAsDoNotDisturb(name, body=None, x__xgafv=None) -
Marks user as`DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
+  
Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
 
 Args:
   name: string, Required. The resource name of the availability to mark as Do Not Disturb. Format: users/{user}/availability `{user}` is the id for the Person in the People API or Admin SDK directory API. For example, `users/123456789`. The user's email address or `me` can also be used as an alias to refer to the caller. For example, `users/user@example.com` or `users/me`. (required)
@@ -285,7 +285,7 @@ 

Method Details

- updateAvailability(name, body=None, updateMask=None, x__xgafv=None) + patch(name, body=None, updateMask=None, x__xgafv=None)
Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`
 
 Args:
diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json
index aa0c07defa..407c425c69 100644
--- a/googleapiclient/discovery_cache/documents/chat.v1.json
+++ b/googleapiclient/discovery_cache/documents/chat.v1.json
@@ -644,7 +644,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages`",
+"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages`",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -1463,11 +1463,11 @@
 "resources": {
 "availability": {
 "methods": {
-"getAvailability": {
+"get": {
 "description": "Returns availability information for a human user in Google Chat. For example, this can be used to check if a user is online or away, or to retrieve their custom status message. This method only retrieves the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability.readonly` - `https://www.googleapis.com/auth/chat.users.availability`",
 "flatPath": "v1/users/{usersId}/availability",
 "httpMethod": "GET",
-"id": "chat.users.availability.getAvailability",
+"id": "chat.users.availability.get",
 "parameterOrder": [
 "name"
 ],
@@ -1549,7 +1549,7 @@
 ]
 },
 "markAsDoNotDisturb": {
-"description": "Marks user as`DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`",
+"description": "Marks user as `DO_NOT_DISTURB` in Google Chat. Sets a user's availability state to `DO_NOT_DISTURB` until a specified expiration time. When in `DO_NOT_DISTURB`, users typically won't receive notifications. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`",
 "flatPath": "v1/users/{usersId}/availability:markAsDoNotDisturb",
 "httpMethod": "POST",
 "id": "chat.users.availability.markAsDoNotDisturb",
@@ -1577,11 +1577,11 @@
 "https://www.googleapis.com/auth/chat.users.readstate"
 ]
 },
-"updateAvailability": {
+"patch": {
 "description": "Updates availability information for a human user. Only the `custom_status` field can be updated through this method. This method only updates the authenticated user's availability. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.availability`",
 "flatPath": "v1/users/{usersId}/availability",
 "httpMethod": "PATCH",
-"id": "chat.users.availability.updateAvailability",
+"id": "chat.users.availability.patch",
 "parameterOrder": [
 "name"
 ],
@@ -2008,13 +2008,46 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260705",
 "rootUrl": "https://chat.googleapis.com/",
 "schemas": {
+"AccessPermissionSetting": {
+"description": "An access permission setting.",
+"id": "AccessPermissionSetting",
+"properties": {
+"principals": {
+"description": "Optional. Unordered list. Allowed principals for this permission.",
+"items": {
+"$ref": "Principal"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"AccessPermissionSettings": {
+"description": "Access permission settings for a space.",
+"id": "AccessPermissionSettings",
+"properties": {
+"discoverSpaceSetting": {
+"$ref": "AccessPermissionSetting",
+"description": "Optional. Access permission setting for discovering the space."
+},
+"joinSpaceSetting": {
+"$ref": "AccessPermissionSetting",
+"description": "Optional. Access permission setting for joining the space."
+}
+},
+"type": "object"
+},
 "AccessSettings": {
 "description": "Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space.",
 "id": "AccessSettings",
 "properties": {
+"accessPermissionSettings": {
+"$ref": "AccessPermissionSettings",
+"description": "Optional. Access permission settings for the space. To set the target audience when creating a space, specify the `accessSettings.audience` field in your request."
+},
 "accessState": {
 "description": "Output only. Indicates the access state of the space.",
 "enum": [
@@ -2316,6 +2349,17 @@
 },
 "type": "object"
 },
+"Audience": {
+"description": "A target audience in Google Chat. A target audience represents a group of users within a Google Workspace organization, defined by an administrator. Target audiences are used to configure access and visibility settings for resources, such as making a space discoverable to a specific group of users. For more details, see [Target audiences](https://support.google.com/a/answer/9934697) and [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience).",
+"id": "Audience",
+"properties": {
+"name": {
+"description": "The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover or join the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Availability": {
 "description": "Represents a user's current availability information in Google Chat, including their state (for example, Active, Away, Do Not Disturb) and any custom status.",
 "id": "Availability",
@@ -5713,6 +5757,17 @@
 },
 "type": "object"
 },
+"Principal": {
+"description": "A principal representing an entity granted access.",
+"id": "Principal",
+"properties": {
+"audience": {
+"$ref": "Audience",
+"description": "An audience."
+}
+},
+"type": "object"
+},
 "QuotedMessageMetadata": {
 "description": "Information about a message that another message quotes. When you update a message, you can't add or replace the `quotedMessageMetadata` field, but you can remove it. For example usage, see [Quote another message](https://developers.google.com/workspace/chat/create-messages#quote-a-message).",
 "id": "QuotedMessageMetadata",

From 5823b133eb8fcc41c9f226d3d3a5ac82b2d53806 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Jul 2026 07:41:47 +0000
Subject: [PATCH 16/50] fix(cloudasset): update the api

#### cloudasset:v1

The following keys were changed:
- resources.assets.methods.list.scopes (Total Keys: 1)
- resources.operations.methods.get.scopes (Total Keys: 1)
- resources.v1.methods.analyzeIamPolicy.scopes (Total Keys: 1)
- resources.v1.methods.analyzeIamPolicyLongrunning.scopes (Total Keys: 1)

#### cloudasset:v1beta1

The following keys were changed:
- resources.folders.resources.operations.methods.get.scopes (Total Keys: 1)
- resources.organizations.resources.operations.methods.get.scopes (Total Keys: 1)
- resources.projects.resources.operations.methods.get.scopes (Total Keys: 1)

#### cloudasset:v1p7beta1

The following keys were changed:
- resources.operations.methods.get.scopes (Total Keys: 1)
---
 docs/dyn/cloudasset_v1.assets.html            | 16 +++++-----
 docs/dyn/cloudasset_v1.v1.html                | 32 +++++++++----------
 .../dyn/cloudasset_v1beta1.organizations.html | 16 +++++-----
 docs/dyn/cloudasset_v1beta1.projects.html     | 16 +++++-----
 docs/dyn/cloudasset_v1p5beta1.assets.html     | 16 +++++-----
 .../documents/cloudasset.v1.json              | 25 +++++++++------
 .../documents/cloudasset.v1beta1.json         | 22 ++++++++-----
 .../documents/cloudasset.v1p1beta1.json       | 10 +++---
 .../documents/cloudasset.v1p5beta1.json       | 10 +++---
 .../documents/cloudasset.v1p7beta1.json       | 16 ++++++----
 10 files changed, 98 insertions(+), 81 deletions(-)

diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html
index e55ffb4b46..71a603f706 100644
--- a/docs/dyn/cloudasset_v1.assets.html
+++ b/docs/dyn/cloudasset_v1.assets.html
@@ -476,8 +476,8 @@ 

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -518,8 +518,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -592,8 +592,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -634,8 +634,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index 4c22d01eab..9614c95052 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -1364,8 +1364,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -1406,8 +1406,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -1480,8 +1480,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -1522,8 +1522,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -1944,8 +1944,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -1986,8 +1986,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -2060,8 +2060,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -2102,8 +2102,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index 078a2b3bfe..bf322eee28 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -272,8 +272,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -314,8 +314,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -388,8 +388,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -430,8 +430,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index f5634b9341..0edcceebe1 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -272,8 +272,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -314,8 +314,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -388,8 +388,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -430,8 +430,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index 6cc26ce53a..45b57f2b24 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -277,8 +277,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -319,8 +319,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, @@ -393,8 +393,8 @@

Method Details

"sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed from access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources. }, @@ -435,8 +435,8 @@

Method Details

"sources": [ # Sources that this IngressPolicy authorizes access from. { # The source that IngressPolicy authorizes access from. "accessLevel": "A String", # An AccessLevel resource name that allow resources within the ServicePerimeters to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all IngressSources will be allowed. - "pscEndpoint": { # Specifies the PSC an API call refers to. # Requests from this PSC will be allowed to access perimeter data. - "forwardingRule": "A String", # The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. + "pscEndpoint": { # Specifies the Private Service Connect endpoint that an API call refers to. # A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in. + "forwardingRule": "A String", # The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`. }, "resource": "A String", # A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported. }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 31b0d6c179..44cc8f5347 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -4,6 +4,9 @@ "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/cloudasset": { +"description": "See, edit, configure, and delete your Google Cloud Asset data and see the email address for your Google Account" } } } @@ -181,7 +184,8 @@ "$ref": "ListAssetsResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -380,7 +384,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -640,7 +645,8 @@ "$ref": "AnalyzeIamPolicyResponse" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] }, "analyzeIamPolicyLongrunning": { @@ -668,7 +674,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] }, "analyzeMove": { @@ -1095,7 +1102,7 @@ } } }, -"revision": "20260624", +"revision": "20260703", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -2934,7 +2941,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed from access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", @@ -3044,7 +3051,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed to access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", @@ -3145,11 +3152,11 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint": { -"description": "Specifies the PSC an API call refers to.", +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", "properties": { "forwardingRule": { -"description": "The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 1391ed0663..018d3c0f98 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -4,6 +4,9 @@ "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/cloudasset": { +"description": "See, edit, configure, and delete your Google Cloud Asset data and see the email address for your Google Account" } } } @@ -161,7 +164,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -282,7 +286,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -403,7 +408,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -411,7 +417,7 @@ } } }, -"revision": "20260624", +"revision": "20260703", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1214,7 +1220,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed from access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", @@ -1324,7 +1330,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed to access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", @@ -1425,11 +1431,11 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint": { -"description": "Specifies the PSC an API call refers to.", +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", "properties": { "forwardingRule": { -"description": "The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index e3828dff9f..47c4a30807 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20260624", +"revision": "20260703", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -916,7 +916,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed from access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", @@ -1026,7 +1026,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed to access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", @@ -1127,11 +1127,11 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint": { -"description": "Specifies the PSC an API call refers to.", +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", "properties": { "forwardingRule": { -"description": "The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index b59559397c..245b66009f 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20260624", +"revision": "20260703", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -921,7 +921,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed from access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", @@ -1031,7 +1031,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed to access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", @@ -1132,11 +1132,11 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint": { -"description": "Specifies the PSC an API call refers to.", +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", "properties": { "forwardingRule": { -"description": "The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 870ddee262..7ff3f09906 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -4,6 +4,9 @@ "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/cloudasset": { +"description": "See, edit, configure, and delete your Google Cloud Asset data and see the email address for your Google Account" } } } @@ -129,7 +132,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudasset" ] } } @@ -167,7 +171,7 @@ } } }, -"revision": "20260624", +"revision": "20260703", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -990,7 +994,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed from access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access data outside the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource from the service perimeter that you want to allow to access data outside the perimeter. This field supports only projects. The project format is `projects/{project_number}`. You can't use `*` in this field to allow all Google Cloud resources.", @@ -1100,7 +1104,7 @@ }, "pscEndpoint": { "$ref": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", -"description": "Requests from this PSC will be allowed to access perimeter data." +"description": "A PrivateServiceConnectEndpoint that is allowed to access the perimeter. The Private Service Connect endpoint may be in any organization, not just the organization that the perimeter is defined in." }, "resource": { "description": "A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects and VPCs are allowed. Project format: `projects/{project_number}` VPC network format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NAME}`. The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. `*` is not allowed, the case of allowing all Google Cloud resources only is not supported.", @@ -1201,11 +1205,11 @@ "type": "object" }, "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint": { -"description": "Specifies the PSC an API call refers to.", +"description": "Specifies the Private Service Connect endpoint that an API call refers to.", "id": "GoogleIdentityAccesscontextmanagerV1PrivateServiceConnectEndpoint", "properties": { "forwardingRule": { -"description": "The global forwarding rule identifier. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", +"description": "The full resource name of the global forwarding rule that identifies a Private Service Connect endpoint. Forwarding rule format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/forwardingRules/{FORWARDING_RULE_ID}`.", "type": "string" } }, From 2781da2958bec95ea2652eb6afaa326c24e3e59b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:48 +0000 Subject: [PATCH 17/50] feat(cloudbuild): update the api #### cloudbuild:v1 The following keys were added: - resources.projects.resources.locations.resources.gitLabConfigs.methods.create.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.methods.delete.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.methods.get.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.methods.list.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.methods.patch.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.methods.removeGitLabConnectedRepository.deprecated (Total Keys: 1) - resources.projects.resources.locations.resources.gitLabConfigs.resources.connectedRepositories (Total Keys: 2) - resources.projects.resources.locations.resources.gitLabConfigs.resources.repos (Total Keys: 2) - schemas.BatchCreateGitLabConnectedRepositoriesRequest.deprecated (Total Keys: 1) - schemas.BatchCreateGitLabConnectedRepositoriesResponse.deprecated (Total Keys: 1) - schemas.BatchCreateGitLabConnectedRepositoriesResponseMetadata.deprecated (Total Keys: 1) - schemas.BuildTrigger.properties.gitlabEnterpriseEventsConfig.deprecated (Total Keys: 1) - schemas.CreateGitLabConfigOperationMetadata.deprecated (Total Keys: 1) - schemas.CreateGitLabConnectedRepositoryRequest.deprecated (Total Keys: 1) - schemas.DeleteGitLabConfigOperationMetadata.deprecated (Total Keys: 1) - schemas.GitLabConfig.deprecated (Total Keys: 1) - schemas.GitLabConnectedRepository.deprecated (Total Keys: 1) - schemas.GitLabEnterpriseConfig.deprecated (Total Keys: 1) - schemas.GitLabEventsConfig.deprecated (Total Keys: 1) - schemas.GitLabRepository.deprecated (Total Keys: 1) - schemas.GitLabSecrets.deprecated (Total Keys: 1) - schemas.ListGitLabConfigsResponse.deprecated (Total Keys: 1) - schemas.ListGitLabRepositoriesResponse.deprecated (Total Keys: 1) - schemas.RemoveGitLabConnectedRepositoryRequest.deprecated (Total Keys: 1) - schemas.ServiceDirectoryConfig.deprecated (Total Keys: 1) - schemas.UpdateGitLabConfigOperationMetadata.deprecated (Total Keys: 1) --- docs/dyn/cloudbuild_v1.projects.builds.html | 20 +-- ...d_v1.projects.githubEnterpriseConfigs.html | 10 +- ...ects.locations.bitbucketServerConfigs.html | 10 +- ...oudbuild_v1.projects.locations.builds.html | 20 +-- ...s.gitLabConfigs.connectedRepositories.html | 10 +- ...d_v1.projects.locations.gitLabConfigs.html | 70 +++++----- ...rojects.locations.gitLabConfigs.repos.html | 8 +- ...cts.locations.githubEnterpriseConfigs.html | 10 +- ...dbuild_v1.projects.locations.triggers.html | 84 ++++++------ docs/dyn/cloudbuild_v1.projects.triggers.html | 84 ++++++------ .../documents/cloudbuild.v1.json | 123 +++++++++++------- 11 files changed, 240 insertions(+), 209 deletions(-) diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index 6c76399f5c..da5c84c1c8 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -79,25 +79,25 @@

Instance Methods

Approves or rejects a pending build. If approved, the returned long-running operation (LRO) will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.

cancel(projectId, id, body=None, x__xgafv=None)

-

Cancels a build in progress.

+

Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.

close()

Close httplib2 connections.

create(projectId, body=None, parent=None, x__xgafv=None)

-

Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).

+

Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.

get(projectId, id, name=None, x__xgafv=None)

-

Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.

+

Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.

list(projectId, filter=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)

-

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

+

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.

list_next()

Retrieves the next page of results.

retry(projectId, id, body=None, x__xgafv=None)

-

Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

+

Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Method Details

approve(name, body=None, x__xgafv=None) @@ -149,7 +149,7 @@

Method Details

cancel(projectId, id, body=None, x__xgafv=None) -
Cancels a build in progress.
+  
Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.
 
 Args:
   projectId: string, Required. ID of the project. (required)
@@ -646,7 +646,7 @@ 

Method Details

create(projectId, body=None, parent=None, x__xgafv=None) -
Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
+  
Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.
 
 Args:
   projectId: string, Required. ID of the project. (required)
@@ -1152,7 +1152,7 @@ 

Method Details

get(projectId, id, name=None, x__xgafv=None) -
Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.
+  
Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.
 
 Args:
   projectId: string, Required. ID of the project. (required)
@@ -1636,7 +1636,7 @@ 

Method Details

list(projectId, filter=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None) -
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
+  
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.
 
 Args:
   projectId: string, Required. ID of the project. (required)
@@ -2141,7 +2141,7 @@ 

Method Details

retry(projectId, id, body=None, x__xgafv=None) -
Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
+  
Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
 
 Args:
   projectId: string, Required. ID of the project. (required)
diff --git a/docs/dyn/cloudbuild_v1.projects.githubEnterpriseConfigs.html b/docs/dyn/cloudbuild_v1.projects.githubEnterpriseConfigs.html
index 7c2e91ee15..5fd7e3e54a 100644
--- a/docs/dyn/cloudbuild_v1.projects.githubEnterpriseConfigs.html
+++ b/docs/dyn/cloudbuild_v1.projects.githubEnterpriseConfigs.html
@@ -112,7 +112,7 @@ 

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -217,7 +217,7 @@

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -256,7 +256,7 @@

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -280,7 +280,7 @@

Method Details

Update an association between a GCP project and a GitHub Enterprise server.
 
 Args:
-  name: string, The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
+  name: string, Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -289,7 +289,7 @@ 

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.bitbucketServerConfigs.html b/docs/dyn/cloudbuild_v1.projects.locations.bitbucketServerConfigs.html index 742faca603..3ca4c2ad88 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.bitbucketServerConfigs.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.bitbucketServerConfigs.html @@ -134,7 +134,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -237,7 +237,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -280,7 +280,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -316,7 +316,7 @@

Method Details

Updates an existing `BitbucketServerConfig`. This API is experimental.
 
 Args:
-  name: string, The resource name for the config. (required)
+  name: string, Identifier. The resource name for the config. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -331,7 +331,7 @@ 

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index cf86ac8393..fa9b6876f8 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -79,25 +79,25 @@

Instance Methods

Approves or rejects a pending build. If approved, the returned long-running operation (LRO) will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done.

cancel(name, body=None, x__xgafv=None)

-

Cancels a build in progress.

+

Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.

close()

Close httplib2 connections.

create(parent, body=None, projectId=None, x__xgafv=None)

-

Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).

+

Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.

get(name, id=None, projectId=None, x__xgafv=None)

-

Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.

+

Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.

list(parent, filter=None, pageSize=None, pageToken=None, projectId=None, x__xgafv=None)

-

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.

+

Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.

list_next()

Retrieves the next page of results.

retry(name, body=None, x__xgafv=None)

-

Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

+

Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.

Method Details

approve(name, body=None, x__xgafv=None) @@ -149,7 +149,7 @@

Method Details

cancel(name, body=None, x__xgafv=None) -
Cancels a build in progress.
+  
Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.
 
 Args:
   name: string, The name of the `Build` to cancel. Format: `projects/{project}/locations/{location}/builds/{build}` (required)
@@ -645,7 +645,7 @@ 

Method Details

create(parent, body=None, projectId=None, x__xgafv=None) -
Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).
+  
Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.
 
 Args:
   parent: string, The parent resource where this build will be created. Format: `projects/{project}/locations/{location}` (required)
@@ -1151,7 +1151,7 @@ 

Method Details

get(name, id=None, projectId=None, x__xgafv=None) -
Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.
+  
Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.
 
 Args:
   name: string, The name of the `Build` to retrieve. Format: `projects/{project}/locations/{location}/builds/{build}` (required)
@@ -1635,7 +1635,7 @@ 

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, projectId=None, x__xgafv=None) -
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.
+  
Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.
 
 Args:
   parent: string, The parent of the collection of `Builds`. Format: `projects/{project}/locations/{location}` (required)
@@ -2140,7 +2140,7 @@ 

Method Details

retry(name, body=None, x__xgafv=None) -
Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
+  
Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.
 
 Args:
   name: string, The name of the `Build` to retry. Format: `projects/{project}/locations/{location}/builds/{build}` (required)
diff --git a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.connectedRepositories.html b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.connectedRepositories.html
index 57bbb7651d..41ade4cc1f 100644
--- a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.connectedRepositories.html
+++ b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.connectedRepositories.html
@@ -76,24 +76,24 @@ 

Cloud Build API . batchCreate(parent, body=None, x__xgafv=None)

-

Batch connecting GitLab repositories to Cloud Build. This API is experimental.

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Batch connecting GitLab repositories to Cloud Build. This API is experimental.

close()

Close httplib2 connections.

Method Details

batchCreate(parent, body=None, x__xgafv=None) -
Batch connecting GitLab repositories to Cloud Build. This API is experimental.
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Batch connecting GitLab repositories to Cloud Build. This API is experimental.
 
 Args:
   parent: string, The name of the `GitLabConfig` that adds connected repositories. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.
+{ # Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.
   "requests": [ # Required. Requests to connect GitLab repositories.
-    { # Request to connect a repository from a connected GitLab host.
-      "gitlabConnectedRepository": { # GitLabConnectedRepository represents a GitLab connected repository request response. # Required. The GitLab repository to connect.
+    { # Deprecated: CloudBuild GitLab V1 integration is deprecated. Request to connect a repository from a connected GitLab host.
+      "gitlabConnectedRepository": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConnectedRepository represents a GitLab connected repository request response. # Required. The GitLab repository to connect.
         "parent": "A String", # The name of the `GitLabConfig` that added connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}`
         "repo": { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise # The GitLab repositories to connect.
           "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
diff --git a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.html b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.html
index ccd319e0e2..fb546d4773 100644
--- a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.html
+++ b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.html
@@ -89,25 +89,25 @@ 

Instance Methods

Close httplib2 connections.

create(parent, body=None, gitlabConfigId=None, x__xgafv=None)

-

Creates a new `GitLabConfig`. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Creates a new `GitLabConfig`. This API is experimental

delete(name, x__xgafv=None)

-

Delete a `GitLabConfig`. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Delete a `GitLabConfig`. This API is experimental

get(name, x__xgafv=None)

-

Retrieves a `GitLabConfig`. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Retrieves a `GitLabConfig`. This API is experimental

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

List all `GitLabConfigs` for a given project. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. List all `GitLabConfigs` for a given project. This API is experimental

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing `GitLabConfig`. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Updates an existing `GitLabConfig`. This API is experimental

removeGitLabConnectedRepository(config, body=None, x__xgafv=None)

-

Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.

Method Details

close() @@ -116,14 +116,14 @@

Method Details

create(parent, body=None, gitlabConfigId=None, x__xgafv=None) -
Creates a new `GitLabConfig`. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Creates a new `GitLabConfig`. This API is experimental
 
 Args:
   parent: string, Required. Name of the parent resource. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # GitLabConfig represents the configuration for a GitLab integration.
+{ # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration.
   "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
     { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
       "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
@@ -131,15 +131,15 @@ 

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -181,7 +181,7 @@

Method Details

delete(name, x__xgafv=None) -
Delete a `GitLabConfig`. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Delete a `GitLabConfig`. This API is experimental
 
 Args:
   name: string, Required. The config resource name. (required)
@@ -216,7 +216,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieves a `GitLabConfig`. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Retrieves a `GitLabConfig`. This API is experimental
 
 Args:
   name: string, Required. The config resource name. (required)
@@ -228,7 +228,7 @@ 

Method Details

Returns: An object of the form: - { # GitLabConfig represents the configuration for a GitLab integration. + { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -236,15 +236,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -257,7 +257,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
List all `GitLabConfigs` for a given project. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. List all `GitLabConfigs` for a given project. This API is experimental
 
 Args:
   parent: string, Required. Name of the parent resource (required)
@@ -271,9 +271,9 @@ 

Method Details

Returns: An object of the form: - { # RPC response object returned by ListGitLabConfigs RPC method. + { # Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by ListGitLabConfigs RPC method. "gitlabConfigs": [ # A list of GitLabConfigs - { # GitLabConfig represents the configuration for a GitLab integration. + { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -281,15 +281,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -319,14 +319,14 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates an existing `GitLabConfig`. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Updates an existing `GitLabConfig`. This API is experimental
 
 Args:
-  name: string, The resource name for the config. (required)
+  name: string, Identifier. The resource name for the config. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # GitLabConfig represents the configuration for a GitLab integration.
+{ # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration.
   "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config.
     { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise
       "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
@@ -334,15 +334,15 @@ 

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -384,14 +384,14 @@

Method Details

removeGitLabConnectedRepository(config, body=None, x__xgafv=None) -
Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.
 
 Args:
   config: string, Required. The name of the `GitLabConfig` to remove a connected repository. Format: `projects/{project}/locations/{location}/gitLabConfigs/{config}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
+{ # Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by RemoveGitLabConnectedRepository RPC method.
   "connectedRepository": { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise # The connected repository to remove.
     "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID
     "webhookId": 42, # Output only. The ID of the webhook that was created for receiving events from this repo. We only create and manage a single webhook for each repo.
diff --git a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.repos.html b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.repos.html
index 6ce43d2b46..3931933edd 100644
--- a/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.repos.html
+++ b/docs/dyn/cloudbuild_v1.projects.locations.gitLabConfigs.repos.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

-

List all repositories for a given `GitLabConfig`. This API is experimental

+

Deprecated: CloudBuild GitLab V1 integration is deprecated. List all repositories for a given `GitLabConfig`. This API is experimental

list_next()

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
List all repositories for a given `GitLabConfig`. This API is experimental
+  
Deprecated: CloudBuild GitLab V1 integration is deprecated. List all repositories for a given `GitLabConfig`. This API is experimental
 
 Args:
   parent: string, Required. Name of the parent resource. (required)
@@ -105,9 +105,9 @@ 

Method Details

Returns: An object of the form: - { # RPC response object returned by the ListGitLabRepositories RPC method. + { # Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by the ListGitLabRepositories RPC method. "gitlabRepositories": [ # List of GitLab repositories - { # Proto Representing a GitLabRepository + { # Deprecated: CloudBuild GitLab V1 integration is deprecated. Proto Representing a GitLabRepository "browseUri": "A String", # Link to the browse repo page on the GitLab instance "description": "A String", # Description of the repository "displayName": "A String", # Display name of the repository diff --git a/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html b/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html index b87e0db864..94aa7453c0 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.githubEnterpriseConfigs.html @@ -112,7 +112,7 @@

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -217,7 +217,7 @@

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -256,7 +256,7 @@

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. @@ -280,7 +280,7 @@

Method Details

Update an association between a GCP project and a GitHub Enterprise server.
 
 Args:
-  name: string, The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
+  name: string, Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -289,7 +289,7 @@ 

Method Details

"createTime": "A String", # Output only. Time when the installation was associated with the project. "displayName": "A String", # Optional. Name to display for this config. "hostUrl": "A String", # The URL of the github enterprise host the configuration is for. - "name": "A String", # The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" + "name": "A String", # Identifier. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the GitHub Enterprise server will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "secrets": { # GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. # Optional. Names of secrets in Secret Manager. "oauthClientIdName": "A String", # The resource name for the OAuth client ID secret in Secret Manager. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index f570cf5ce4..9ec882c31f 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -133,7 +133,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -670,8 +670,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -679,15 +679,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -798,7 +798,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -1335,8 +1335,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -1344,15 +1344,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -1491,7 +1491,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -2028,8 +2028,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -2037,15 +2037,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -2168,7 +2168,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -2705,8 +2705,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -2714,15 +2714,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -2850,7 +2850,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -3387,8 +3387,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -3396,15 +3396,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -3517,7 +3517,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -4054,8 +4054,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -4063,15 +4063,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index e65a4d2c9e..1815bda1c3 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -133,7 +133,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -670,8 +670,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -679,15 +679,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -798,7 +798,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -1335,8 +1335,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -1344,15 +1344,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -1491,7 +1491,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -2028,8 +2028,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -2037,15 +2037,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -2168,7 +2168,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -2705,8 +2705,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -2714,15 +2714,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -2851,7 +2851,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -3388,8 +3388,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -3397,15 +3397,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version @@ -3516,7 +3516,7 @@

Method Details

], "createTime": "A String", # Time when the config was created. "hostUri": "A String", # Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. - "name": "A String", # The resource name for the config. + "name": "A String", # Identifier. The resource name for the config. "peeredNetwork": "A String", # Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. "peeredNetworkIpRange": "A String", # Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. "secrets": { # BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. # Required. Secret Manager secrets needed by the config. @@ -4053,8 +4053,8 @@

Method Details

"tag": "A String", # Regexes matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax }, }, - "gitlabEnterpriseEventsConfig": { # GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. - "gitlabConfig": { # GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. + "gitlabEnterpriseEventsConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received. + "gitlabConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration. # Output only. The GitLabConfig specified in the gitlab_config_resource field. "connectedRepositories": [ # Connected GitLab.com or GitLabEnterprise repositories for this config. { # GitLabRepositoryId identifies a specific repository hosted on GitLab.com or GitLabEnterprise "id": "A String", # Required. Identifier for the repository. example: "namespace/project-slug", namespace is usually the username or group ID @@ -4062,15 +4062,15 @@

Method Details

}, ], "createTime": "A String", # Output only. Time when the config was created. - "enterpriseConfig": { # GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. + "enterpriseConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. # Optional. GitLabEnterprise config. "hostUri": "A String", # Immutable. The URI of the GitlabEnterprise host. - "serviceDirectoryConfig": { # ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. + "serviceDirectoryConfig": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection. # The Service Directory configuration to be used when reaching out to the GitLab Enterprise instance. "service": "A String", # The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. }, "sslCa": "A String", # The SSL certificate to use in requests to GitLab Enterprise instances. }, - "name": "A String", # The resource name for the config. - "secrets": { # GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. + "name": "A String", # Identifier. The resource name for the config. + "secrets": { # Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. # Required. Secret Manager secrets needed by the config. "apiAccessTokenVersion": "A String", # Required. The resource name for the api access token’s secret version "apiKeyVersion": "A String", # Required. Immutable. API Key that will be attached to webhook requests from GitLab to Cloud Build. "readAccessTokenVersion": "A String", # Required. The resource name for the read access token’s secret version diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 92251aede7..54242a1736 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -491,7 +491,7 @@ ] }, "cancel": { -"description": "Cancels a build in progress.", +"description": "Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "flatPath": "v1/projects/{projectId}/builds/{id}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.builds.cancel", @@ -525,7 +525,7 @@ ] }, "create": { -"description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).", +"description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "POST", "id": "cloudbuild.projects.builds.create", @@ -557,7 +557,7 @@ ] }, "get": { -"description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.", +"description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", "flatPath": "v1/projects/{projectId}/builds/{id}", "httpMethod": "GET", "id": "cloudbuild.projects.builds.get", @@ -593,7 +593,7 @@ ] }, "list": { -"description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.", +"description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectId}/builds", "httpMethod": "GET", "id": "cloudbuild.projects.builds.list", @@ -638,7 +638,7 @@ ] }, "retry": { -"description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", +"description": "Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectId}/builds/{id}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.builds.retry", @@ -829,7 +829,7 @@ ], "parameters": { "name": { -"description": "The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", +"description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "pattern": "^projects/[^/]+/githubEnterpriseConfigs/[^/]+$", "required": true, @@ -1015,7 +1015,7 @@ ], "parameters": { "name": { -"description": "The resource name for the config.", +"description": "Identifier. The resource name for the config.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/bitbucketServerConfigs/[^/]+$", "required": true, @@ -1174,7 +1174,7 @@ ] }, "cancel": { -"description": "Cancels a build in progress.", +"description": "Cancels a build in progress. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:cancel`. To cancel regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:cancel`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:cancel", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.cancel", @@ -1202,7 +1202,7 @@ ] }, "create": { -"description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`).", +"description": "Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). Note: This method only creates global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To create regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.create", @@ -1235,7 +1235,7 @@ ] }, "get": { -"description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information.", +"description": "Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}`. To fetch regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.builds.get", @@ -1270,7 +1270,7 @@ ] }, "list": { -"description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully.", +"description": "Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. Note: This method only lists global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds`. To list regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds", "httpMethod": "GET", "id": "cloudbuild.projects.locations.builds.list", @@ -1316,7 +1316,7 @@ ] }, "retry": { -"description": "Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", +"description": "Creates a new build based on the specified build. Note: This method only applies to global (non-regional) builds when using the legacy resource path `projects/{project_id}/builds/{id}:retry`. To retry regional builds, use the regional resource path: `projects/{project_id}/locations/{location}/builds/{id}:retry`. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/builds/{buildsId}:retry", "httpMethod": "POST", "id": "cloudbuild.projects.locations.builds.retry", @@ -1348,7 +1348,8 @@ "gitLabConfigs": { "methods": { "create": { -"description": "Creates a new `GitLabConfig`. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Creates a new `GitLabConfig`. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs", "httpMethod": "POST", "id": "cloudbuild.projects.locations.gitLabConfigs.create", @@ -1381,7 +1382,8 @@ ] }, "delete": { -"description": "Delete a `GitLabConfig`. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Delete a `GitLabConfig`. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", "httpMethod": "DELETE", "id": "cloudbuild.projects.locations.gitLabConfigs.delete", @@ -1406,7 +1408,8 @@ ] }, "get": { -"description": "Retrieves a `GitLabConfig`. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Retrieves a `GitLabConfig`. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", "httpMethod": "GET", "id": "cloudbuild.projects.locations.gitLabConfigs.get", @@ -1431,7 +1434,8 @@ ] }, "list": { -"description": "List all `GitLabConfigs` for a given project. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. List all `GitLabConfigs` for a given project. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs", "httpMethod": "GET", "id": "cloudbuild.projects.locations.gitLabConfigs.list", @@ -1467,7 +1471,8 @@ ] }, "patch": { -"description": "Updates an existing `GitLabConfig`. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Updates an existing `GitLabConfig`. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}", "httpMethod": "PATCH", "id": "cloudbuild.projects.locations.gitLabConfigs.patch", @@ -1476,7 +1481,7 @@ ], "parameters": { "name": { -"description": "The resource name for the config.", +"description": "Identifier. The resource name for the config.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gitLabConfigs/[^/]+$", "required": true, @@ -1501,7 +1506,8 @@ ] }, "removeGitLabConnectedRepository": { -"description": "Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Remove a GitLab repository from a given GitLabConfig's connected repositories. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}:removeGitLabConnectedRepository", "httpMethod": "POST", "id": "cloudbuild.projects.locations.gitLabConfigs.removeGitLabConnectedRepository", @@ -1531,9 +1537,11 @@ }, "resources": { "connectedRepositories": { +"deprecated": true, "methods": { "batchCreate": { -"description": "Batch connecting GitLab repositories to Cloud Build. This API is experimental.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Batch connecting GitLab repositories to Cloud Build. This API is experimental.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}/connectedRepositories:batchCreate", "httpMethod": "POST", "id": "cloudbuild.projects.locations.gitLabConfigs.connectedRepositories.batchCreate", @@ -1563,9 +1571,11 @@ } }, "repos": { +"deprecated": true, "methods": { "list": { -"description": "List all repositories for a given `GitLabConfig`. This API is experimental", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. List all repositories for a given `GitLabConfig`. This API is experimental", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gitLabConfigs/{gitLabConfigsId}/repos", "httpMethod": "GET", "id": "cloudbuild.projects.locations.gitLabConfigs.repos.list", @@ -1760,7 +1770,7 @@ ], "parameters": { "name": { -"description": "The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", +"description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/githubEnterpriseConfigs/[^/]+$", "required": true, @@ -2583,7 +2593,7 @@ } } }, -"revision": "20260511", +"revision": "20260627", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -2799,7 +2809,8 @@ "type": "object" }, "BatchCreateGitLabConnectedRepositoriesRequest": { -"description": "RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by BatchCreateGitLabConnectedRepositories RPC method.", "id": "BatchCreateGitLabConnectedRepositoriesRequest", "properties": { "requests": { @@ -2813,7 +2824,8 @@ "type": "object" }, "BatchCreateGitLabConnectedRepositoriesResponse": { -"description": "Response of BatchCreateGitLabConnectedRepositories RPC method.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Response of BatchCreateGitLabConnectedRepositories RPC method.", "id": "BatchCreateGitLabConnectedRepositoriesResponse", "properties": { "gitlabConnectedRepositories": { @@ -2827,7 +2839,8 @@ "type": "object" }, "BatchCreateGitLabConnectedRepositoriesResponseMetadata": { -"description": "Metadata for `BatchCreateGitLabConnectedRepositories` operation.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `BatchCreateGitLabConnectedRepositories` operation.", "id": "BatchCreateGitLabConnectedRepositoriesResponseMetadata", "properties": { "completeTime": { @@ -2873,7 +2886,7 @@ "type": "string" }, "name": { -"description": "The resource name for the config.", +"description": "Identifier. The resource name for the config.", "type": "string" }, "peeredNetwork": { @@ -3362,7 +3375,8 @@ false "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32", -"E2_MEDIUM" +"E2_MEDIUM", +"E2_STANDARD_2" ], "enumDeprecated": [ false, @@ -3370,6 +3384,7 @@ true, true, false, false, +false, false ], "enumDescriptions": [ @@ -3378,7 +3393,8 @@ false "Highcpu machine with 32 CPUs.", "Highcpu e2 machine with 8 CPUs.", "Highcpu e2 machine with 32 CPUs.", -"E2 machine with 1 CPU." +"E2 machine with 1 CPU.", +"E2 machine with 2 CPUs." ], "type": "string" }, @@ -3682,7 +3698,8 @@ false }, "gitlabEnterpriseEventsConfig": { "$ref": "GitLabEventsConfig", -"description": "GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received." +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab Enterprise event is received." }, "id": { "description": "Output only. Unique identifier of the trigger.", @@ -3906,7 +3923,8 @@ false "type": "object" }, "CreateGitLabConfigOperationMetadata": { -"description": "Metadata for `CreateGitLabConfig` operation.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `CreateGitLabConfig` operation.", "id": "CreateGitLabConfigOperationMetadata", "properties": { "completeTime": { @@ -3927,7 +3945,8 @@ false "type": "object" }, "CreateGitLabConnectedRepositoryRequest": { -"description": "Request to connect a repository from a connected GitLab host.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Request to connect a repository from a connected GitLab host.", "id": "CreateGitLabConnectedRepositoryRequest", "properties": { "gitlabConnectedRepository": { @@ -4021,7 +4040,8 @@ false "type": "object" }, "DeleteGitLabConfigOperationMetadata": { -"description": "Metadata for `DeleteGitLabConfig` operation.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `DeleteGitLabConfig` operation.", "id": "DeleteGitLabConfigOperationMetadata", "properties": { "completeTime": { @@ -4311,7 +4331,7 @@ false "type": "string" }, "name": { -"description": "The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", +"description": "Identifier. The full resource name for the GitHubEnterpriseConfig For example: \"projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}\"", "type": "string" }, "peeredNetwork": { @@ -4410,7 +4430,8 @@ false "type": "object" }, "GitLabConfig": { -"description": "GitLabConfig represents the configuration for a GitLab integration.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConfig represents the configuration for a GitLab integration.", "id": "GitLabConfig", "properties": { "connectedRepositories": { @@ -4431,7 +4452,7 @@ false "description": "Optional. GitLabEnterprise config." }, "name": { -"description": "The resource name for the config.", +"description": "Identifier. The resource name for the config.", "type": "string" }, "secrets": { @@ -4451,7 +4472,8 @@ false "type": "object" }, "GitLabConnectedRepository": { -"description": "GitLabConnectedRepository represents a GitLab connected repository request response.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabConnectedRepository represents a GitLab connected repository request response.", "id": "GitLabConnectedRepository", "properties": { "parent": { @@ -4471,7 +4493,8 @@ false "type": "object" }, "GitLabEnterpriseConfig": { -"description": "GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration.", "id": "GitLabEnterpriseConfig", "properties": { "hostUri": { @@ -4490,7 +4513,8 @@ false "type": "object" }, "GitLabEventsConfig": { -"description": "GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received.", "id": "GitLabEventsConfig", "properties": { "gitlabConfig": { @@ -4518,7 +4542,8 @@ false "type": "object" }, "GitLabRepository": { -"description": "Proto Representing a GitLabRepository", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Proto Representing a GitLabRepository", "id": "GitLabRepository", "properties": { "browseUri": { @@ -4562,7 +4587,8 @@ false "type": "object" }, "GitLabSecrets": { -"description": "GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. GitLabSecrets represents the secrets in Secret Manager for a GitLab integration.", "id": "GitLabSecrets", "properties": { "apiAccessTokenVersion": { @@ -4886,7 +4912,8 @@ false "type": "object" }, "ListGitLabConfigsResponse": { -"description": "RPC response object returned by ListGitLabConfigs RPC method.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by ListGitLabConfigs RPC method.", "id": "ListGitLabConfigsResponse", "properties": { "gitlabConfigs": { @@ -4904,7 +4931,8 @@ false "type": "object" }, "ListGitLabRepositoriesResponse": { -"description": "RPC response object returned by the ListGitLabRepositories RPC method.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC response object returned by the ListGitLabRepositories RPC method.", "id": "ListGitLabRepositoriesResponse", "properties": { "gitlabRepositories": { @@ -5321,7 +5349,8 @@ false "type": "object" }, "RemoveGitLabConnectedRepositoryRequest": { -"description": "RPC request object accepted by RemoveGitLabConnectedRepository RPC method.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. RPC request object accepted by RemoveGitLabConnectedRepository RPC method.", "id": "RemoveGitLabConnectedRepositoryRequest", "properties": { "connectedRepository": { @@ -5592,7 +5621,8 @@ false "type": "object" }, "ServiceDirectoryConfig": { -"description": "ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. ServiceDirectoryConfig represents Service Directory configuration for a SCM host connection.", "id": "ServiceDirectoryConfig", "properties": { "service": { @@ -5830,7 +5860,8 @@ false "type": "object" }, "UpdateGitLabConfigOperationMetadata": { -"description": "Metadata for `UpdateGitLabConfig` operation.", +"deprecated": true, +"description": "Deprecated: CloudBuild GitLab V1 integration is deprecated. Metadata for `UpdateGitLabConfig` operation.", "id": "UpdateGitLabConfigOperationMetadata", "properties": { "completeTime": { From 6b73cd09823a12ce1ac841249a50022e213eaf32 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:48 +0000 Subject: [PATCH 18/50] feat(cloudkms): update the api #### cloudkms:v1 The following keys were added: - resources.folders.methods.showEffectiveAutokeyConfig (Total Keys: 11) - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.methods.create.parameters.trustedWrappingEnabled (Total Keys: 2) - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.exportTrustedKeyWrappedCryptoKeyVersion (Total Keys: 13) - resources.projects.resources.locations.resources.keyRings.resources.cryptoKeys.resources.cryptoKeyVersions.methods.importTrustedKeyWrappedCryptoKeyVersion (Total Keys: 12) - schemas.CryptoKeyVersion.properties.hsmTrusted (Total Keys: 2) - schemas.CryptoKeyVersion.properties.trustedWrappingEnabled.type (Total Keys: 1) - schemas.ExportTrustedKeyWrappedCryptoKeyVersionResponse (Total Keys: 6) - schemas.ExternalProtectionLevelOptions.properties.ekmConnectionBackendOverride.type (Total Keys: 1) - schemas.ImportCryptoKeyVersionRequest.properties.trustedWrappingEnabled.type (Total Keys: 1) - schemas.ImportTrustedKeyWrappedCryptoKeyVersionRequest (Total Keys: 7) - schemas.ShowEffectiveAutokeyConfigResponse.properties.keyProjectResolutionMode.type (Total Keys: 1) - schemas.ShowEffectiveAutokeyConfigResponse.properties.source.$ref (Total Keys: 1) - schemas.SingleTenantHsmInstanceProposal.properties.upgradeKeyTrust.$ref (Total Keys: 1) - schemas.Source (Total Keys: 3) - schemas.UpgradeKeyTrust (Total Keys: 4) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/cloudkms_v1.folders.html | 26 ++ docs/dyn/cloudkms_v1.projects.html | 12 +- ...keyRings.cryptoKeys.cryptoKeyVersions.html | 155 ++++++- ...rojects.locations.keyRings.cryptoKeys.html | 54 ++- ...ns.singleTenantHsmInstances.proposals.html | 12 + .../documents/cloudkms.v1.json | 393 ++++++++++++++++-- 6 files changed, 572 insertions(+), 80 deletions(-) diff --git a/docs/dyn/cloudkms_v1.folders.html b/docs/dyn/cloudkms_v1.folders.html index 87534408e1..1c27d0ed33 100644 --- a/docs/dyn/cloudkms_v1.folders.html +++ b/docs/dyn/cloudkms_v1.folders.html @@ -83,6 +83,9 @@

Instance Methods

getKajPolicyConfig(name, x__xgafv=None)

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

+

+ showEffectiveAutokeyConfig(parent, x__xgafv=None)

+

Returns the effective Cloud KMS Autokey configuration for a given project or folder.

updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)

Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.

@@ -143,6 +146,29 @@

Method Details

}
+
+ showEffectiveAutokeyConfig(parent, x__xgafv=None) +
Returns the effective Cloud KMS Autokey configuration for a given project or folder.
+
+Args:
+  parent: string, Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder} (required)
+  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 ShowEffectiveAutokeyConfig.
+  "keyProject": "A String", # Name of the key project configured in the ancestry of the project or folder.
+  "keyProjectResolutionMode": "A String", # The KeyProjectResolutionMode for the AutokeyConfig.
+  "source": { # Source of the effective AutokeyConfig. # Source of the effective AutokeyConfig.
+    "name": "A String", # Contains the resource name of the AutokeyConfig that is effective, for example, `folders/{FOLDER_NUMBER}` or `projects/{PROJECT_NUMBER}` or `organizations/{ORGANIZATION_NUMBER}`.
+  },
+}
+
+
updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.
diff --git a/docs/dyn/cloudkms_v1.projects.html b/docs/dyn/cloudkms_v1.projects.html
index c7cca8d64f..dff9f805ad 100644
--- a/docs/dyn/cloudkms_v1.projects.html
+++ b/docs/dyn/cloudkms_v1.projects.html
@@ -90,7 +90,7 @@ 

Instance Methods

Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.

showEffectiveAutokeyConfig(parent, x__xgafv=None)

-

Returns the effective Cloud KMS Autokey configuration for a given project.

+

Returns the effective Cloud KMS Autokey configuration for a given project or folder.

showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)

Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.

@@ -159,10 +159,10 @@

Method Details

showEffectiveAutokeyConfig(parent, x__xgafv=None) -
Returns the effective Cloud KMS Autokey configuration for a given project.
+  
Returns the effective Cloud KMS Autokey configuration for a given project or folder.
 
 Args:
-  parent: string, Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. (required)
+  parent: string, Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder} (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -172,7 +172,11 @@ 

Method Details

An object of the form: { # Response message for ShowEffectiveAutokeyConfig. - "keyProject": "A String", # Name of the key project configured in the resource project's folder ancestry. + "keyProject": "A String", # Name of the key project configured in the ancestry of the project or folder. + "keyProjectResolutionMode": "A String", # The KeyProjectResolutionMode for the AutokeyConfig. + "source": { # Source of the effective AutokeyConfig. # Source of the effective AutokeyConfig. + "name": "A String", # Contains the resource name of the AutokeyConfig that is effective, for example, `folders/{FOLDER_NUMBER}` or `projects/{PROJECT_NUMBER}` or `organizations/{ORGANIZATION_NUMBER}`. + }, }
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html index 2fb9907ca8..79ea9e2595 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.html @@ -95,12 +95,18 @@

Instance Methods

destroy(name, body=None, x__xgafv=None)

Schedule a CryptoKeyVersion for destruction. Upon calling this method, CryptoKeyVersion.state will be set to DESTROY_SCHEDULED, and destroy_time will be set to the time destroy_scheduled_duration in the future. At that time, the state will automatically change to DESTROYED, and the key material will be irrevocably destroyed. Before the destroy_time is reached, RestoreCryptoKeyVersion may be called to reverse the process.

+

+ exportTrustedKeyWrappedCryptoKeyVersion(name, wrappingKey=None, x__xgafv=None)

+

Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm.

get(name, x__xgafv=None)

Returns metadata for a given CryptoKeyVersion.

getPublicKey(name, publicKeyFormat=None, x__xgafv=None)

Returns the public key for the given CryptoKeyVersion. The CryptoKey.purpose must be ASYMMETRIC_SIGN or ASYMMETRIC_DECRYPT.

+

+ importTrustedKeyWrappedCryptoKeyVersion(parent, body=None, x__xgafv=None)

+

Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true.

import_(parent, body=None, x__xgafv=None)

Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.

@@ -234,11 +240,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -246,6 +254,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. } x__xgafv: string, V1 error format. @@ -278,11 +287,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -290,6 +301,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }
@@ -401,11 +413,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -413,6 +427,28 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. +}
+
+ +
+ exportTrustedKeyWrappedCryptoKeyVersion(name, wrappingKey=None, x__xgafv=None) +
Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm.
+
+Args:
+  name: string, Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. (required)
+  wrappingKey: string, Required. The name of the CryptoKeyVersion to use as a wrapping key. The CryptoKeyVersion must have hsm_trusted set to true.
+  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 KeyManagementService.ExportTrustedKeyWrappedCryptoKeyVersion.
+  "wrappedKey": "A String", # The wrapped key material.
+  "wrappedKeyCrc32c": "A String", # Integrity verification field. A CRC32C checksum of the returned ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key. An integrity check of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key can be performed by computing the CRC32C checksum of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.
 }
@@ -452,11 +488,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -464,6 +502,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }
@@ -502,6 +541,70 @@

Method Details

}
+
+ importTrustedKeyWrappedCryptoKeyVersion(parent, body=None, x__xgafv=None) +
Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true.
+
+Args:
+  parent: string, Required. The name of the CryptoKey to be imported into. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for KeyManagementService.ImportTrustedKeyWrappedCryptoKeyVersion.
+  "algorithm": "A String", # Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.
+  "cryptoKeyVersion": "A String", # Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material
+  "importingKey": "A String", # Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.
+  "wrappedKey": "A String", # Required. The target key pre-wrapped on premises.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS.
+  "algorithm": "A String", # Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports.
+  "attestation": { # Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). # Output only. Statement that was generated and signed by the HSM at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only provided for key versions with protection_level HSM.
+    "certChains": { # Certificate chains needed to verify the attestation. Certificates in chains are PEM-encoded and are ordered based on https://tools.ietf.org/html/rfc5246#section-7.4.2. # Output only. The certificate chains needed to validate the attestation
+      "caviumCerts": [ # Cavium certificate chain corresponding to the attestation.
+        "A String",
+      ],
+      "googleCardCerts": [ # Google card certificate chain corresponding to the attestation.
+        "A String",
+      ],
+      "googlePartitionCerts": [ # Google partition certificate chain corresponding to the attestation.
+        "A String",
+      ],
+    },
+    "content": "A String", # Output only. The attestation data provided by the HSM when the key operation was performed.
+    "format": "A String", # Output only. The format of the attestation data.
+  },
+  "createTime": "A String", # Output only. The time at which this CryptoKeyVersion was created.
+  "destroyEventTime": "A String", # Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED.
+  "destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED.
+  "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED.
+  "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.
+    "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`.
+    "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection.
+    "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents.
+  },
+  "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated.
+  "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED.
+  "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT.
+  "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.
+  "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported.
+  "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported.
+  "name": "A String", # Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.
+  "protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion.
+  "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version.
+  "state": "A String", # The current state of the CryptoKeyVersion.
+  "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.
+}
+
+
import_(parent, body=None, x__xgafv=None)
Import wrapped key material into a CryptoKeyVersion. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey.
@@ -516,6 +619,7 @@ 

Method Details

"cryptoKeyVersion": "A String", # Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportCryptoKeyVersionRequest.parent, have been previously created via ImportCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material. "importJob": "A String", # Required. The name of the ImportJob that was used to wrap this key material. "rsaAesWrappedKey": "A String", # Optional. This field has the same meaning as wrapped_key. Prefer to use that field in new work. Either that field or this field (but not both) must be specified. + "trustedWrappingEnabled": True or False, # Optional. Whether trusted wrapping will be enabled on the imported [CryptoKeyVersion]. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes besides ENCRYPT_DECRYPT. "wrappedKey": "A String", # Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label. } @@ -549,11 +653,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -561,6 +667,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }
@@ -610,11 +717,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -622,6 +731,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, ], "nextPageToken": "A String", # A token to retrieve next page of results. Pass this value in ListCryptoKeyVersionsRequest.page_token to retrieve the next page of results. @@ -739,11 +849,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -751,6 +863,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. } updateMask: string, Required. List of fields to be updated in this request. @@ -784,11 +897,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -796,6 +911,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }
@@ -918,11 +1034,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -930,6 +1048,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }
diff --git a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html index d6e18d970f..8f5f90a093 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html +++ b/docs/dyn/cloudkms_v1.projects.locations.keyRings.cryptoKeys.html @@ -83,7 +83,7 @@

Instance Methods

close()

Close httplib2 connections.

- create(parent, body=None, cryptoKeyId=None, skipInitialVersionCreation=None, x__xgafv=None)

+ create(parent, body=None, cryptoKeyId=None, skipInitialVersionCreation=None, trustedWrappingEnabled=None, x__xgafv=None)

Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.

decrypt(name, body=None, x__xgafv=None)

@@ -125,7 +125,7 @@

Method Details

- create(parent, body=None, cryptoKeyId=None, skipInitialVersionCreation=None, x__xgafv=None) + create(parent, body=None, cryptoKeyId=None, skipInitialVersionCreation=None, trustedWrappingEnabled=None, x__xgafv=None)
Create a new CryptoKey within a KeyRing. CryptoKey.purpose and CryptoKey.version_template.algorithm are required.
 
 Args:
@@ -170,11 +170,13 @@ 

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -182,6 +184,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -193,6 +196,7 @@

Method Details

cryptoKeyId: string, Required. It must be unique within a KeyRing and match the regular expression `[a-zA-Z0-9_-]{1,63}` skipInitialVersionCreation: boolean, If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey. + trustedWrappingEnabled: boolean, Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -238,11 +242,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -250,6 +256,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -412,11 +419,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -424,6 +433,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -543,11 +553,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -555,6 +567,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -629,11 +642,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -641,6 +656,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -696,11 +712,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -708,6 +726,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. @@ -891,11 +910,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -903,6 +924,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. diff --git a/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.proposals.html b/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.proposals.html index 9da34e7c8e..400fb6ebe1 100644 --- a/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.proposals.html +++ b/docs/dyn/cloudkms_v1.projects.locations.singleTenantHsmInstances.proposals.html @@ -218,6 +218,10 @@

Method Details

}, "state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal. "ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration. + "upgradeKeyTrust": { # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. + "name": "A String", # Required. The name of the CryptoKeyVersion to promote. + "twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key that will sign the login nonce for this operation. + }, } singleTenantHsmInstanceProposalId: string, Optional. It must be unique within a location and match the regular expression `[a-zA-Z0-9_-]{1,63}`. @@ -382,6 +386,10 @@

Method Details

}, "state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal. "ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration. + "upgradeKeyTrust": { # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. + "name": "A String", # Required. The name of the CryptoKeyVersion to promote. + "twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key that will sign the login nonce for this operation. + }, }
@@ -466,6 +474,10 @@

Method Details

}, "state": "A String", # Output only. The state of the SingleTenantHsmInstanceProposal. "ttl": "A String", # Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration. + "upgradeKeyTrust": { # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. # Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation. + "name": "A String", # Required. The name of the CryptoKeyVersion to promote. + "twoFactorPublicKeyPem": "A String", # Required. The public key associated with the 2FA key that will sign the login nonce for this operation. + }, }, ], "totalSize": 42, # The total number of SingleTenantHsmInstanceProposals that matched the query. This field is not populated if ListSingleTenantHsmInstanceProposalsRequest.filter is applied. diff --git a/googleapiclient/discovery_cache/documents/cloudkms.v1.json b/googleapiclient/discovery_cache/documents/cloudkms.v1.json index 0d61aeb94b..d2f4ef47f4 100644 --- a/googleapiclient/discovery_cache/documents/cloudkms.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudkms.v1.json @@ -21,31 +21,6 @@ "endpoints": [ { "description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.europe-west8.rep.googleapis.com/", -"location": "europe-west8" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-central1.rep.googleapis.com/", -"location": "us-central1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-west4.rep.googleapis.com/", -"location": "us-west4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-east5.rep.googleapis.com/", -"location": "us-east5" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://cloudkms.us-south1.rep.googleapis.com/", -"location": "us-south1" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-east7.rep.googleapis.com/", "location": "us-east7" }, @@ -101,6 +76,31 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudkms.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://cloudkms.northamerica-northeast1.rep.googleapis.com/", "location": "northamerica-northeast1" }, @@ -269,6 +269,32 @@ "https://www.googleapis.com/auth/cloudkms" ] }, +"showEffectiveAutokeyConfig": { +"description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder.", +"flatPath": "v1/folders/{foldersId}:showEffectiveAutokeyConfig", +"httpMethod": "GET", +"id": "cloudkms.folders.showEffectiveAutokeyConfig", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", +"location": "path", +"pattern": "^folders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:showEffectiveAutokeyConfig", +"response": { +"$ref": "ShowEffectiveAutokeyConfigResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudkms" +] +}, "updateAutokeyConfig": { "description": "Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.", "flatPath": "v1/folders/{foldersId}/autokeyConfig", @@ -461,7 +487,7 @@ ] }, "showEffectiveAutokeyConfig": { -"description": "Returns the effective Cloud KMS Autokey configuration for a given project.", +"description": "Returns the effective Cloud KMS Autokey configuration for a given project or folder.", "flatPath": "v1/projects/{projectsId}:showEffectiveAutokeyConfig", "httpMethod": "GET", "id": "cloudkms.projects.showEffectiveAutokeyConfig", @@ -470,7 +496,7 @@ ], "parameters": { "parent": { -"description": "Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.", +"description": "Required. Name of the resource project or folder to show the effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. Format: * projects/{project} * folders/{folder}", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1468,6 +1494,11 @@ "description": "If set to true, the request will create a CryptoKey without any CryptoKeyVersions. You must manually call CreateCryptoKeyVersion or ImportCryptoKeyVersion before you can use this CryptoKey.", "location": "query", "type": "boolean" +}, +"trustedWrappingEnabled": { +"description": "Optional. Whether trusted wrapping will be enabled on the first CryptoKeyVersions created for this CryptoKey. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes except ENCRYPT_DECRYPT.", +"location": "query", +"type": "boolean" } }, "path": "v1/{+parent}/cryptoKeys", @@ -1981,6 +2012,37 @@ "https://www.googleapis.com/auth/cloudkms" ] }, +"exportTrustedKeyWrappedCryptoKeyVersion": { +"description": "Exports a CryptoKeyVersion with a trusted key. The CryptoKeyVersion must have trusted_wrapping_enabled set to true. The CryptoKeyVersion of the [wrapping_key] must have the AES_WRAPPING purpose. The [wrapping_key] must have the AES_256_KWP algorithm.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:exportTrustedKeyWrappedCryptoKeyVersion", +"httpMethod": "GET", +"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.exportTrustedKeyWrappedCryptoKeyVersion", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the CryptoKeyVersion to export. The CryptoKeyVersion must have trusted_wrapping_enabled set to true.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", +"required": true, +"type": "string" +}, +"wrappingKey": { +"description": "Required. The name of the CryptoKeyVersion to use as a wrapping key. The CryptoKeyVersion must have hsm_trusted set to true.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:exportTrustedKeyWrappedCryptoKeyVersion", +"response": { +"$ref": "ExportTrustedKeyWrappedCryptoKeyVersionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudkms" +] +}, "get": { "description": "Returns metadata for a given CryptoKeyVersion.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}", @@ -2081,6 +2143,35 @@ "https://www.googleapis.com/auth/cloudkms" ] }, +"importTrustedKeyWrappedCryptoKeyVersion": { +"description": "Import wrapped key material into a CryptoKeyVersion with a trusted key. All requests must specify a CryptoKey. If a CryptoKeyVersion is additionally specified in the request, key material will be reimported into that version. Otherwise, a new version will be created, and will be assigned the next sequential id within the CryptoKey. The CryptoKeyVersion will have trusted_wrapping_enabled set to true.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions:importTrustedKeyWrappedCryptoKeyVersion", +"httpMethod": "POST", +"id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.importTrustedKeyWrappedCryptoKeyVersion", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the CryptoKey to be imported into.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/cryptoKeyVersions:importTrustedKeyWrappedCryptoKeyVersion", +"request": { +"$ref": "ImportTrustedKeyWrappedCryptoKeyVersionRequest" +}, +"response": { +"$ref": "CryptoKeyVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloudkms" +] +}, "list": { "description": "Lists CryptoKeyVersions.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions", @@ -2967,7 +3058,7 @@ } } }, -"revision": "20260608", +"revision": "20260702", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AddQuorumMember": { @@ -3204,7 +3295,7 @@ "DISABLED" ], "enumDescriptions": [ -"Default value. KeyProjectResolutionMode when not specified will act as `DEDICATED_KEY_PROJECT`.", +"Default value. When KeyProjectResolutionMode is set to KEY_PROJECT_RESOLUTION_MODE_UNSPECIFIED for a folder and that folder has a key_project set, the folder acts like its KeyProjectResolutionMode is DEDICATED_KEY_PROJECT.", "Keys are created in a dedicated project specified by `key_project`.", "Keys are created in the same project as the resource requesting the key. The `key_project` must not be set when this mode is used.", "Disables the AutokeyConfig. When this mode is set, any AutokeyConfig from higher levels in the resource hierarchy are ignored for this resource and its descendants. This setting can be overridden by a more specific configuration at a lower level. For example, if Autokey is disabled on a folder, it can be re-enabled on a sub-folder or project within that folder by setting a different mode (e.g., DEDICATED_KEY_PROJECT or RESOURCE_PROJECT)." @@ -3460,7 +3551,8 @@ true "ASYMMETRIC_DECRYPT", "RAW_ENCRYPT_DECRYPT", "MAC", -"KEY_ENCAPSULATION" +"KEY_ENCAPSULATION", +"AES_WRAPPING" ], "enumDescriptions": [ "Not specified.", @@ -3469,7 +3561,8 @@ true "CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey.", "CryptoKeys with this purpose may be used with RawEncrypt and RawDecrypt. This purpose is meant to be used for interoperable symmetric encryption and does not support automatic CryptoKey rotation.", "CryptoKeys with this purpose may be used with MacSign.", -"CryptoKeys with this purpose may be used with GetPublicKey and Decapsulate." +"CryptoKeys with this purpose may be used with GetPublicKey and Decapsulate.", +"CryptoKeys with this purpose may be used for AES key" ], "type": "string" }, @@ -3538,7 +3631,8 @@ true "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -3587,7 +3681,8 @@ true "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "readOnly": true, "type": "string" @@ -3635,6 +3730,11 @@ true "readOnly": true, "type": "string" }, +"hsmTrusted": { +"description": "Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT.", +"readOnly": true, +"type": "boolean" +}, "importFailureReason": { "description": "Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.", "readOnly": true, @@ -3711,6 +3811,10 @@ true "This version was destroyed, and it may not be used or enabled again. However, Cloud KMS could not confirm that the corresponding key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason." ], "type": "string" +}, +"trustedWrappingEnabled": { +"description": "Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.", +"type": "boolean" } }, "type": "object" @@ -3768,7 +3872,8 @@ true "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -3817,7 +3922,8 @@ true "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "type": "string" }, @@ -4176,6 +4282,23 @@ true "properties": {}, "type": "object" }, +"ExportTrustedKeyWrappedCryptoKeyVersionResponse": { +"description": "Response message for KeyManagementService.ExportTrustedKeyWrappedCryptoKeyVersion.", +"id": "ExportTrustedKeyWrappedCryptoKeyVersionResponse", +"properties": { +"wrappedKey": { +"description": "The wrapped key material.", +"format": "byte", +"type": "string" +}, +"wrappedKeyCrc32c": { +"description": "Integrity verification field. A CRC32C checksum of the returned ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key. An integrity check of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key can be performed by computing the CRC32C checksum of ExportTrustedKeyWrappedCryptoKeyVersionResponse.wrapped_key and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "Expr": { "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", "id": "Expr", @@ -4203,12 +4326,16 @@ true "description": "ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.", "id": "ExternalProtectionLevelOptions", "properties": { +"ekmConnectionBackendOverride": { +"description": "Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`.", +"type": "string" +}, "ekmConnectionKeyPath": { -"description": "The path to the external key material on the EKM when using EkmConnection e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an EkmConnection.", +"description": "Optional. The path to the external key material on the EKM when using EkmConnection e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an EkmConnection.", "type": "string" }, "externalKeyUri": { -"description": "The URI for an external resource that this CryptoKeyVersion represents.", +"description": "Optional. The URI for an external resource that this CryptoKeyVersion represents.", "type": "string" } }, @@ -4316,7 +4443,8 @@ true "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -4365,7 +4493,8 @@ true "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "type": "string" }, @@ -4382,6 +4511,10 @@ true "format": "byte", "type": "string" }, +"trustedWrappingEnabled": { +"description": "Optional. Whether trusted wrapping will be enabled on the imported [CryptoKeyVersion]. This field is only supported for keys with CryptoKeyVersionTemplate.protection_level HSM_SINGLE_TENANT. This field is supported for all CryptoKeyPurposes besides ENCRYPT_DECRYPT.", +"type": "boolean" +}, "wrappedKey": { "description": "Optional. The wrapped key material to import. Before wrapping, key material must be formatted. If importing symmetric key material, the expected key material format is plain bytes. If importing asymmetric key material, the expected key material format is PKCS#8-encoded DER (the PrivateKeyInfo structure from RFC 5208). When wrapping with import methods (RSA_OAEP_3072_SHA1_AES_256 or RSA_OAEP_4096_SHA1_AES_256 or RSA_OAEP_3072_SHA256_AES_256 or RSA_OAEP_4096_SHA256_AES_256), this field must contain the concatenation of: 1. An ephemeral AES-256 wrapping key wrapped with the public_key using RSAES-OAEP with SHA-1/SHA-256, MGF1 with SHA-1/SHA-256, and an empty label. 2. The formatted key to be imported, wrapped with the ephemeral AES-256 key using AES-KWP (RFC 5649). This format is the same as the format produced by PKCS#11 mechanism CKM_RSA_AES_KEY_WRAP. When wrapping with import methods (RSA_OAEP_3072_SHA256 or RSA_OAEP_4096_SHA256), this field must contain the formatted key to be imported, wrapped with the public_key using RSAES-OAEP with SHA-256, MGF1 with SHA-256, and an empty label.", "format": "byte", @@ -4524,6 +4657,130 @@ true }, "type": "object" }, +"ImportTrustedKeyWrappedCryptoKeyVersionRequest": { +"description": "Request message for KeyManagementService.ImportTrustedKeyWrappedCryptoKeyVersion.", +"id": "ImportTrustedKeyWrappedCryptoKeyVersionRequest", +"properties": { +"algorithm": { +"description": "Required. Required - The algorithm of the key being imported. This does not need to match the version_template of the CryptoKey this version imports into.", +"enum": [ +"CRYPTO_KEY_VERSION_ALGORITHM_UNSPECIFIED", +"GOOGLE_SYMMETRIC_ENCRYPTION", +"AES_128_GCM", +"AES_256_GCM", +"AES_128_CBC", +"AES_256_CBC", +"AES_128_CTR", +"AES_256_CTR", +"RSA_SIGN_PSS_2048_SHA256", +"RSA_SIGN_PSS_3072_SHA256", +"RSA_SIGN_PSS_4096_SHA256", +"RSA_SIGN_PSS_4096_SHA512", +"RSA_SIGN_PKCS1_2048_SHA256", +"RSA_SIGN_PKCS1_3072_SHA256", +"RSA_SIGN_PKCS1_4096_SHA256", +"RSA_SIGN_PKCS1_4096_SHA512", +"RSA_SIGN_RAW_PKCS1_2048", +"RSA_SIGN_RAW_PKCS1_3072", +"RSA_SIGN_RAW_PKCS1_4096", +"RSA_DECRYPT_OAEP_2048_SHA256", +"RSA_DECRYPT_OAEP_3072_SHA256", +"RSA_DECRYPT_OAEP_4096_SHA256", +"RSA_DECRYPT_OAEP_4096_SHA512", +"RSA_DECRYPT_OAEP_2048_SHA1", +"RSA_DECRYPT_OAEP_3072_SHA1", +"RSA_DECRYPT_OAEP_4096_SHA1", +"EC_SIGN_P256_SHA256", +"EC_SIGN_P384_SHA384", +"EC_SIGN_SECP256K1_SHA256", +"EC_SIGN_ED25519", +"HMAC_SHA256", +"HMAC_SHA1", +"HMAC_SHA384", +"HMAC_SHA512", +"HMAC_SHA224", +"EXTERNAL_SYMMETRIC_ENCRYPTION", +"ML_KEM_768", +"ML_KEM_1024", +"KEM_XWING", +"PQ_SIGN_ML_DSA_44", +"PQ_SIGN_ML_DSA_65", +"PQ_SIGN_ML_DSA_87", +"PQ_SIGN_SLH_DSA_SHA2_128S", +"PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", +"PQ_SIGN_ML_DSA_44_EXTERNAL_MU", +"PQ_SIGN_ML_DSA_65_EXTERNAL_MU", +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" +], +"enumDescriptions": [ +"Not specified.", +"Creates symmetric encryption keys.", +"AES-GCM (Galois Counter Mode) using 128-bit keys.", +"AES-GCM (Galois Counter Mode) using 256-bit keys.", +"AES-CBC (Cipher Block Chaining Mode) using 128-bit keys.", +"AES-CBC (Cipher Block Chaining Mode) using 256-bit keys.", +"AES-CTR (Counter Mode) using 128-bit keys.", +"AES-CTR (Counter Mode) using 256-bit keys.", +"RSASSA-PSS 2048 bit key with a SHA256 digest.", +"RSASSA-PSS 3072 bit key with a SHA256 digest.", +"RSASSA-PSS 4096 bit key with a SHA256 digest.", +"RSASSA-PSS 4096 bit key with a SHA512 digest.", +"RSASSA-PKCS1-v1_5 with a 2048 bit key and a SHA256 digest.", +"RSASSA-PKCS1-v1_5 with a 3072 bit key and a SHA256 digest.", +"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA256 digest.", +"RSASSA-PKCS1-v1_5 with a 4096 bit key and a SHA512 digest.", +"RSASSA-PKCS1-v1_5 signing without encoding, with a 2048 bit key.", +"RSASSA-PKCS1-v1_5 signing without encoding, with a 3072 bit key.", +"RSASSA-PKCS1-v1_5 signing without encoding, with a 4096 bit key.", +"RSAES-OAEP 2048 bit key with a SHA256 digest.", +"RSAES-OAEP 3072 bit key with a SHA256 digest.", +"RSAES-OAEP 4096 bit key with a SHA256 digest.", +"RSAES-OAEP 4096 bit key with a SHA512 digest.", +"RSAES-OAEP 2048 bit key with a SHA1 digest.", +"RSAES-OAEP 3072 bit key with a SHA1 digest.", +"RSAES-OAEP 4096 bit key with a SHA1 digest.", +"ECDSA on the NIST P-256 curve with a SHA256 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms", +"ECDSA on the NIST P-384 curve with a SHA384 digest. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms", +"ECDSA on the non-NIST secp256k1 curve. This curve is only supported for HSM protection level. Other hash functions can also be used: https://cloud.google.com/kms/docs/create-validate-signatures#ecdsa_support_for_other_hash_algorithms", +"EdDSA on the Curve25519 in pure mode (taking data as input).", +"HMAC-SHA256 signing with a 256 bit key.", +"HMAC-SHA1 signing with a 160 bit key.", +"HMAC-SHA384 signing with a 384 bit key.", +"HMAC-SHA512 signing with a 512 bit key.", +"HMAC-SHA224 signing with a 224 bit key.", +"Algorithm representing symmetric encryption by an external key manager.", +"ML-KEM-768 (FIPS 203)", +"ML-KEM-1024 (FIPS 203)", +"X-Wing hybrid KEM combining ML-KEM-768 with X25519 following datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized version.", +"The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." +], +"type": "string" +}, +"cryptoKeyVersion": { +"description": "Optional. The optional name of an existing CryptoKeyVersion to target for an import operation. If this field is not present, a new CryptoKeyVersion containing the supplied key material is created. If this field is present, the supplied key material is imported into the existing CryptoKeyVersion. To import into an existing CryptoKeyVersion, the CryptoKeyVersion must be a child of ImportTrustedKeyWrappedCryptoKeyVersionRequest.parent, have been previously created via ImportTrustedKeyWrappedCryptoKeyVersion, and be in DESTROYED or IMPORT_FAILED state. The key material and algorithm must match the previous CryptoKeyVersion exactly if the CryptoKeyVersion has ever contained key material", +"type": "string" +}, +"importingKey": { +"description": "Required. Required - the CKV of the trusted key used to import. This can be the name of a CryptoKeyVersion or a CryptoKey.", +"type": "string" +}, +"wrappedKey": { +"description": "Required. The target key pre-wrapped on premises.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, "KeyAccessJustificationsEnrollmentConfig": { "description": "Represents the configuration of a protection level for a project's Key Access Justifications enrollment.", "id": "KeyAccessJustificationsEnrollmentConfig", @@ -5214,7 +5471,8 @@ false "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -5263,7 +5521,8 @@ false "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "type": "string" }, @@ -5765,8 +6024,28 @@ false "id": "ShowEffectiveAutokeyConfigResponse", "properties": { "keyProject": { -"description": "Name of the key project configured in the resource project's folder ancestry.", +"description": "Name of the key project configured in the ancestry of the project or folder.", +"type": "string" +}, +"keyProjectResolutionMode": { +"description": "The KeyProjectResolutionMode for the AutokeyConfig.", +"enum": [ +"KEY_PROJECT_RESOLUTION_MODE_UNSPECIFIED", +"DEDICATED_KEY_PROJECT", +"RESOURCE_PROJECT", +"DISABLED" +], +"enumDescriptions": [ +"Default value. When KeyProjectResolutionMode is set to KEY_PROJECT_RESOLUTION_MODE_UNSPECIFIED for a folder and that folder has a key_project set, the folder acts like its KeyProjectResolutionMode is DEDICATED_KEY_PROJECT.", +"Keys are created in a dedicated project specified by `key_project`.", +"Keys are created in the same project as the resource requesting the key. The `key_project` must not be set when this mode is used.", +"Disables the AutokeyConfig. When this mode is set, any AutokeyConfig from higher levels in the resource hierarchy are ignored for this resource and its descendants. This setting can be overridden by a more specific configuration at a lower level. For example, if Autokey is disabled on a folder, it can be re-enabled on a sub-folder or project within that folder by setting a different mode (e.g., DEDICATED_KEY_PROJECT or RESOURCE_PROJECT)." +], "type": "string" +}, +"source": { +"$ref": "Source", +"description": "Source of the effective AutokeyConfig." } }, "type": "object" @@ -5974,6 +6253,21 @@ false "description": "Input only. The TTL for the SingleTenantHsmInstanceProposal. Proposals will expire after this duration.", "format": "google-duration", "type": "string" +}, +"upgradeKeyTrust": { +"$ref": "UpgradeKeyTrust", +"description": "Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation." +} +}, +"type": "object" +}, +"Source": { +"description": "Source of the effective AutokeyConfig.", +"id": "Source", +"properties": { +"name": { +"description": "Contains the resource name of the AutokeyConfig that is effective, for example, `folders/{FOLDER_NUMBER}` or `projects/{PROJECT_NUMBER}` or `organizations/{ORGANIZATION_NUMBER}`.", +"type": "string" } }, "type": "object" @@ -6044,6 +6338,21 @@ false }, "type": "object" }, +"UpgradeKeyTrust": { +"description": "Promotes a key with the AES_WRAPPING purpose to a trusted wrapping key. The key must be in the ACTIVE state to perform this operation.", +"id": "UpgradeKeyTrust", +"properties": { +"name": { +"description": "Required. The name of the CryptoKeyVersion to promote.", +"type": "string" +}, +"twoFactorPublicKeyPem": { +"description": "Required. The public key associated with the 2FA key that will sign the login nonce for this operation.", +"type": "string" +} +}, +"type": "object" +}, "VerifyConnectivityResponse": { "description": "Response message for EkmService.VerifyConnectivity.", "id": "VerifyConnectivityResponse", From d41494dc23e7e2e68bdc4990d5ce52515e531773 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:49 +0000 Subject: [PATCH 19/50] feat(cloudsupport): update the api #### cloudsupport:v2 The following keys were added: - resources.supportEventSubscriptions.methods.expunge (Total Keys: 12) - schemas.Empty (Total Keys: 2) - schemas.ExpungeSupportEventSubscriptionRequest (Total Keys: 2) #### cloudsupport:v2beta The following keys were added: - resources.supportEventSubscriptions.methods.expunge (Total Keys: 12) - schemas.Empty (Total Keys: 2) - schemas.ExpungeSupportEventSubscriptionRequest (Total Keys: 2) --- ...dsupport_v2.supportEventSubscriptions.html | 51 +++++++++++++----- ...port_v2beta.supportEventSubscriptions.html | 51 +++++++++++++----- .../documents/cloudsupport.v2.json | 54 ++++++++++++++++--- .../documents/cloudsupport.v2beta.json | 54 ++++++++++++++++--- 4 files changed, 172 insertions(+), 38 deletions(-) diff --git a/docs/dyn/cloudsupport_v2.supportEventSubscriptions.html b/docs/dyn/cloudsupport_v2.supportEventSubscriptions.html index 8f8758ed8d..058df48e39 100644 --- a/docs/dyn/cloudsupport_v2.supportEventSubscriptions.html +++ b/docs/dyn/cloudsupport_v2.supportEventSubscriptions.html @@ -79,25 +79,28 @@

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates a support event subscription for an organization.

+

Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```

delete(name, x__xgafv=None)

-

Soft deletes a support event subscription.

+

Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

+ expunge(name, body=None, x__xgafv=None)

+

Expunges a support event subscription.

get(name, x__xgafv=None)

-

Gets a support event subscription.

+

Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

-

Lists support event subscriptions.

+

Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a support event subscription.

+

Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```

undelete(name, body=None, x__xgafv=None)

-

Undeletes a support event subscription.

+

Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ``` Undeletes a support event subscription.

Method Details

close() @@ -106,7 +109,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a support event subscription for an organization.
+  
Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id} (required)
@@ -146,7 +149,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Soft deletes a support event subscription.
+  
Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
@@ -170,9 +173,33 @@ 

Method Details

}
+
+ expunge(name, body=None, x__xgafv=None) +
Expunges a support event subscription.
+
+Args:
+  name: string, Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ExpungeSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+
get(name, x__xgafv=None) -
Gets a support event subscription.
+  
Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
@@ -198,7 +225,7 @@ 

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists support event subscriptions.
+  
Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id} (required)
@@ -247,7 +274,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a support event subscription.
+  
Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```
 
 Args:
   name: string, Identifier. The resource name of the support event subscription. (required)
@@ -288,7 +315,7 @@ 

Method Details

undelete(name, body=None, x__xgafv=None) -
Undeletes a support event subscription.
+  
Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ``` Undeletes a support event subscription.
 
 Args:
   name: string, Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
diff --git a/docs/dyn/cloudsupport_v2beta.supportEventSubscriptions.html b/docs/dyn/cloudsupport_v2beta.supportEventSubscriptions.html
index 1d9d2c9ced..448c10ec77 100644
--- a/docs/dyn/cloudsupport_v2beta.supportEventSubscriptions.html
+++ b/docs/dyn/cloudsupport_v2beta.supportEventSubscriptions.html
@@ -79,25 +79,28 @@ 

Instance Methods

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

-

Creates a support event subscription for an organization.

+

Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```

delete(name, x__xgafv=None)

-

Soft deletes a support event subscription.

+

Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

+

+ expunge(name, body=None, x__xgafv=None)

+

Expunges a support event subscription.

get(name, x__xgafv=None)

-

Gets a support event subscription.

+

Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```

list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)

-

Lists support event subscriptions.

+

Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a support event subscription.

+

Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```

undelete(name, body=None, x__xgafv=None)

-

Undeletes a support event subscription.

+

Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ``` Undeletes a support event subscription.

Method Details

close() @@ -106,7 +109,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a support event subscription for an organization.
+  
Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "pub_sub_topic": "projects/my-project/topics/my-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().create( parent="organizations/123456789", body={ "pub_sub_topic": "projects/my-project/topics/my-topic" }, ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The parent resource name where the support event subscription will be created. Format: organizations/{organization_id} (required)
@@ -146,7 +149,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Soft deletes a support event subscription.
+  
Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request DELETE \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService).supportEventSubscriptions().delete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the support event subscription to delete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
@@ -170,9 +173,33 @@ 

Method Details

}
+
+ expunge(name, body=None, x__xgafv=None) +
Expunges a support event subscription.
+
+Args:
+  name: string, Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for ExpungeSupportEventSubscription.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+
get(name, x__xgafv=None) -
Gets a support event subscription.
+  
Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().get( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ```
 
 Args:
   name: string, Required. The name of the support event subscription to retrieve. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
@@ -198,7 +225,7 @@ 

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Lists support event subscriptions.
+  
Lists support event subscriptions. EXAMPLES: cURL: ```shell parent="organizations/123456789" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().list( parent="organizations/123456789" ) print(request.execute()) ```
 
 Args:
   parent: string, Required. The fully qualified name of the Cloud resource to list support event subscriptions under. Format: organizations/{organization_id} (required)
@@ -247,7 +274,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a support event subscription.
+  
Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "pub_sub_topic": "projects/my-project/topics/new-topic" }' \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().patch( name="organizations/123456789/supportEventSubscriptions/abcdef123456", body={ "pub_sub_topic": "projects/my-project/topics/new-topic" }, ) print(request.execute()) ```
 
 Args:
   name: string, Identifier. The resource name of the support event subscription. (required)
@@ -288,7 +315,7 @@ 

Method Details

undelete(name, body=None, x__xgafv=None) -
Undeletes a support event subscription.
+  
Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription="organizations/123456789/supportEventSubscriptions/abcdef123456" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete" ``` Python: ```python import googleapiclient.discovery api_version = "v2beta" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.supportEventSubscriptions().undelete( name="organizations/123456789/supportEventSubscriptions/abcdef123456" ) print(request.execute()) ``` Undeletes a support event subscription.
 
 Args:
   name: string, Required. The name of the support event subscription to undelete. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id} (required)
diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json
index 470ae8f5d7..ceaf4c4e27 100644
--- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json
+++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json
@@ -604,7 +604,7 @@
 "supportEventSubscriptions": {
 "methods": {
 "create": {
-"description": "Creates a support event subscription for an organization.",
+"description": "Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().create( parent=\"organizations/123456789\", body={ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }, ) print(request.execute()) ```",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions",
 "httpMethod": "POST",
 "id": "cloudsupport.supportEventSubscriptions.create",
@@ -632,7 +632,7 @@
 ]
 },
 "delete": {
-"description": "Soft deletes a support event subscription.",
+"description": "Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request DELETE \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService).supportEventSubscriptions().delete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "DELETE",
 "id": "cloudsupport.supportEventSubscriptions.delete",
@@ -656,8 +656,36 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"expunge": {
+"description": "Expunges a support event subscription.",
+"flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge",
+"httpMethod": "POST",
+"id": "cloudsupport.supportEventSubscriptions.expunge",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}",
+"location": "path",
+"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2/{+name}:expunge",
+"request": {
+"$ref": "ExpungeSupportEventSubscriptionRequest"
+},
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Gets a support event subscription.",
+"description": "Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().get( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "GET",
 "id": "cloudsupport.supportEventSubscriptions.get",
@@ -682,7 +710,7 @@
 ]
 },
 "list": {
-"description": "Lists support event subscriptions.",
+"description": "Lists support event subscriptions. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().list( parent=\"organizations/123456789\" ) print(request.execute()) ```",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions",
 "httpMethod": "GET",
 "id": "cloudsupport.supportEventSubscriptions.list",
@@ -728,7 +756,7 @@
 ]
 },
 "patch": {
-"description": "Updates a support event subscription.",
+"description": "Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription?updateMask=pub_sub_topic\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().patch( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\", body={ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }, ) print(request.execute()) ```",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "PATCH",
 "id": "cloudsupport.supportEventSubscriptions.patch",
@@ -762,7 +790,7 @@
 ]
 },
 "undelete": {
-"description": "Undeletes a support event subscription.",
+"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ``` Undeletes a support event subscription.",
 "flatPath": "v2/{v2Id}/{v2Id1}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete",
 "httpMethod": "POST",
 "id": "cloudsupport.supportEventSubscriptions.undelete",
@@ -792,7 +820,7 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260707",
 "rootUrl": "https://cloudsupport.googleapis.com/",
 "schemas": {
 "Actor": {
@@ -1285,6 +1313,12 @@
 },
 "type": "object"
 },
+"Empty": {
+"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",
+"properties": {},
+"type": "object"
+},
 "EscalateCaseRequest": {
 "description": "The request message for the EscalateCase endpoint.",
 "id": "EscalateCaseRequest",
@@ -1323,6 +1357,12 @@
 },
 "type": "object"
 },
+"ExpungeSupportEventSubscriptionRequest": {
+"description": "Request message for ExpungeSupportEventSubscription.",
+"id": "ExpungeSupportEventSubscriptionRequest",
+"properties": {},
+"type": "object"
+},
 "ListAttachmentsResponse": {
 "description": "The response message for the ListAttachments endpoint.",
 "id": "ListAttachmentsResponse",
diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
index 473a269c9e..ee236f7ce0 100644
--- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
+++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json
@@ -671,7 +671,7 @@
 "supportEventSubscriptions": {
 "methods": {
 "create": {
-"description": "Creates a support event subscription for an organization.",
+"description": "Creates a support event subscription for an organization. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header 'Content-Type: application/json' \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().create( parent=\"organizations/123456789\", body={ \"pub_sub_topic\": \"projects/my-project/topics/my-topic\" }, ) print(request.execute()) ```",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions",
 "httpMethod": "POST",
 "id": "cloudsupport.supportEventSubscriptions.create",
@@ -699,7 +699,7 @@
 ]
 },
 "delete": {
-"description": "Soft deletes a support event subscription.",
+"description": "Soft deletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request DELETE \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService).supportEventSubscriptions().delete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "DELETE",
 "id": "cloudsupport.supportEventSubscriptions.delete",
@@ -723,8 +723,36 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"expunge": {
+"description": "Expunges a support event subscription.",
+"flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}:expunge",
+"httpMethod": "POST",
+"id": "cloudsupport.supportEventSubscriptions.expunge",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the support event subscription to expunge. Format: organizations/{organization_id}/supportEventSubscriptions/{subscription_id}",
+"location": "path",
+"pattern": "^[^/]+/[^/]+/supportEventSubscriptions/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v2beta/{+name}:expunge",
+"request": {
+"$ref": "ExpungeSupportEventSubscriptionRequest"
+},
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
-"description": "Gets a support event subscription.",
+"description": "Gets a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().get( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ```",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "GET",
 "id": "cloudsupport.supportEventSubscriptions.get",
@@ -749,7 +777,7 @@
 ]
 },
 "list": {
-"description": "Lists support event subscriptions.",
+"description": "Lists support event subscriptions. EXAMPLES: cURL: ```shell parent=\"organizations/123456789\" curl \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$parent/supportEventSubscriptions\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().list( parent=\"organizations/123456789\" ) print(request.execute()) ```",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions",
 "httpMethod": "GET",
 "id": "cloudsupport.supportEventSubscriptions.list",
@@ -795,7 +823,7 @@
 ]
 },
 "patch": {
-"description": "Updates a support event subscription.",
+"description": "Updates a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request PATCH \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ --header \"Content-Type: application/json\" \\ --data '{ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }' \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription?updateMask=pub_sub_topic\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().patch( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\", body={ \"pub_sub_topic\": \"projects/my-project/topics/new-topic\" }, ) print(request.execute()) ```",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}",
 "httpMethod": "PATCH",
 "id": "cloudsupport.supportEventSubscriptions.patch",
@@ -829,7 +857,7 @@
 ]
 },
 "undelete": {
-"description": "Undeletes a support event subscription.",
+"description": "Undeletes a support event subscription. EXAMPLES: cURL: ```shell support_event_subscription=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" curl \\ --request POST \\ --header \"Authorization: Bearer $(gcloud auth print-access-token)\" \\ \"https://cloudsupport.googleapis.com/v2beta/$support_event_subscription:undelete\" ``` Python: ```python import googleapiclient.discovery api_version = \"v2beta\" supportApiService = googleapiclient.discovery.build( serviceName=\"cloudsupport\", version=api_version, discoveryServiceUrl=f\"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}\", ) request = supportApiService.supportEventSubscriptions().undelete( name=\"organizations/123456789/supportEventSubscriptions/abcdef123456\" ) print(request.execute()) ``` Undeletes a support event subscription.",
 "flatPath": "v2beta/{v2betaId}/{v2betaId1}/supportEventSubscriptions/{supportEventSubscriptionsId}:undelete",
 "httpMethod": "POST",
 "id": "cloudsupport.supportEventSubscriptions.undelete",
@@ -859,7 +887,7 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260707",
 "rootUrl": "https://cloudsupport.googleapis.com/",
 "schemas": {
 "Actor": {
@@ -1424,6 +1452,12 @@
 },
 "type": "object"
 },
+"Empty": {
+"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",
+"properties": {},
+"type": "object"
+},
 "EscalateCaseRequest": {
 "description": "The request message for the EscalateCase endpoint.",
 "id": "EscalateCaseRequest",
@@ -1462,6 +1496,12 @@
 },
 "type": "object"
 },
+"ExpungeSupportEventSubscriptionRequest": {
+"description": "Request message for ExpungeSupportEventSubscription.",
+"id": "ExpungeSupportEventSubscriptionRequest",
+"properties": {},
+"type": "object"
+},
 "FeedItem": {
 "description": "A feed item associated with a support case.",
 "id": "FeedItem",

From 11e89e1408d4a1a65b38cf85c749909ec6ee9f3b Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Jul 2026 07:41:49 +0000
Subject: [PATCH 20/50] feat(composer): update the api

#### composer:v1

The following keys were added:
- schemas.SoftwareConfig.properties.auditLogsReplicationMode.type (Total Keys: 1)

#### composer:v1beta1

The following keys were added:
- schemas.SoftwareConfig.properties.auditLogsReplicationMode.type (Total Keys: 1)
---
 ...poser_v1.projects.locations.environments.html |  4 ++++
 ..._v1beta1.projects.locations.environments.html |  4 ++++
 .../discovery_cache/documents/composer.v1.json   | 16 +++++++++++++++-
 .../documents/composer.v1beta1.json              | 16 +++++++++++++++-
 4 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html
index 99430a9e67..34e238ad25 100644
--- a/docs/dyn/composer_v1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1.projects.locations.environments.html
@@ -289,6 +289,7 @@ 

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -629,6 +630,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -815,6 +817,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -1055,6 +1058,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html index a0e49a3c03..8be4be3e7d 100644 --- a/docs/dyn/composer_v1beta1.projects.locations.environments.html +++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html @@ -294,6 +294,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -639,6 +640,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -830,6 +832,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, @@ -1075,6 +1078,7 @@

Method Details

"airflowConfigOverrides": { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example "core-dags_are_paused_at_creation". Section names must not contain hyphens ("-"), opening square brackets ("["), or closing square brackets ("]"). The property name must not be empty and must not contain an equals sign ("=") or semicolon (";"). Section and property names must not contain a period ("."). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden. "a_key": "A String", }, + "auditLogsReplicationMode": "A String", # Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer. "cloudDataLineageIntegration": { # Configuration for Cloud Data Lineage integration. # Optional. The configuration for Cloud Data Lineage integration. "enabled": True or False, # Optional. Whether or not Cloud Data Lineage integration is enabled. }, diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 9d43fcd3c2..c46f210cdc 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -1278,7 +1278,7 @@ } } }, -"revision": "20260325", +"revision": "20260622", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2568,6 +2568,20 @@ "description": "Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example \"core-dags_are_paused_at_creation\". Section names must not contain hyphens (\"-\"), opening square brackets (\"[\"), or closing square brackets (\"]\"). The property name must not be empty and must not contain an equals sign (\"=\") or semicolon (\";\"). Section and property names must not contain a period (\".\"). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.", "type": "object" }, +"auditLogsReplicationMode": { +"description": "Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.", +"enum": [ +"AUDIT_LOGS_REPLICATION_MODE_UNSPECIFIED", +"AUDIT_LOGS_REPLICATION_DISABLED", +"AUDIT_LOGS_REPLICATION_ENABLED" +], +"enumDescriptions": [ +"The user's choice of logs replication mode is unspecified.", +"The user opted out of audit logs replication.", +"The user opted in to audit logs replication." +], +"type": "string" +}, "cloudDataLineageIntegration": { "$ref": "CloudDataLineageIntegration", "description": "Optional. The configuration for Cloud Data Lineage integration." diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index 624f64f245..ad0f4eeeab 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -1278,7 +1278,7 @@ } } }, -"revision": "20260525", +"revision": "20260622", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -2587,6 +2587,20 @@ "description": "Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example \"core-dags_are_paused_at_creation\". Section names must not contain hyphens (\"-\"), opening square brackets (\"[\"), or closing square brackets (\"]\"). The property name must not be empty and must not contain an equals sign (\"=\") or semicolon (\";\"). Section and property names must not contain a period (\".\"). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.", "type": "object" }, +"auditLogsReplicationMode": { +"description": "Optional. The selected mode of audit logs replication. This field is supported for Cloud Composer environments in versions composer-3-airflow-*.*.*-build.* and newer.", +"enum": [ +"AUDIT_LOGS_REPLICATION_MODE_UNSPECIFIED", +"AUDIT_LOGS_REPLICATION_DISABLED", +"AUDIT_LOGS_REPLICATION_ENABLED" +], +"enumDescriptions": [ +"The user's choice of logs replication mode is unspecified.", +"The user opted out of audit logs replication.", +"The user opted in to audit logs replication." +], +"type": "string" +}, "cloudDataLineageIntegration": { "$ref": "CloudDataLineageIntegration", "description": "Optional. The configuration for Cloud Data Lineage integration." From 469818624010b58407834729e193c8e3258ef5b9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:50 +0000 Subject: [PATCH 21/50] feat(compute): update the api #### compute:alpha The following keys were added: - resources.acceleratorPodControllers.methods.delete (Total Keys: 19) - resources.acceleratorPodControllers.methods.get (Total Keys: 17) - resources.acceleratorPodControllers.methods.insert (Total Keys: 16) - resources.acceleratorPodControllers.methods.list (Total Keys: 26) - resources.acceleratorPodControllers.methods.patch (Total Keys: 23) - resources.dhcpOptionsConfigs.methods.delete (Total Keys: 21) - resources.dhcpOptionsConfigs.methods.get (Total Keys: 19) - resources.dhcpOptionsConfigs.methods.insert (Total Keys: 18) - resources.dhcpOptionsConfigs.methods.list (Total Keys: 28) - resources.dhcpOptionsConfigs.methods.patch (Total Keys: 25) - resources.dhcpOptionsConfigs.methods.testIamPermissions (Total Keys: 20) - schemas.AcceleratorPodController (Total Keys: 33) - schemas.AccessConfig.properties.publicDnsName.deprecated (Total Keys: 1) - schemas.AccessConfig.properties.setPublicDns.deprecated (Total Keys: 1) - schemas.AliasIpRange.properties.candidateSubnetworkRangeNames (Total Keys: 2) - schemas.AliasIpRange.properties.effectiveSubnetworkRangeName (Total Keys: 2) - schemas.AuthenticationConfig (Total Keys: 3) - schemas.DhcpOptionsConfig (Total Keys: 66) - schemas.FutureReservation.properties.resourceName.type (Total Keys: 1) - schemas.FutureReservation.properties.storagePoolProperties.$ref (Total Keys: 1) - schemas.FutureReservationStatus.properties.exapoolProvisionedCapacityGb (Total Keys: 2) - schemas.FutureReservationStatus.properties.storagePoolProvisionedCapacity (Total Keys: 2) - schemas.FutureReservationStoragePoolProperties (Total Keys: 5) - schemas.FutureReservationStoragePoolProvisionedCapacity (Total Keys: 8) - schemas.Instance.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.InstanceProperties.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.ManagementInterface (Total Keys: 10) - schemas.ResourceStatusScheduling.properties.gracefulShutdownTimestamp (Total Keys: 2) - schemas.RouterStatusBgpPeerStatus.properties.depreferenced (Total Keys: 2) - schemas.WorkloadIdentityConfig.properties.identityType.type (Total Keys: 1) #### compute:beta The following keys were added: - resources.reliabilityRisks.methods.get (Total Keys: 15) - resources.reliabilityRisks.methods.list (Total Keys: 24) - schemas.Commitment.properties.persistentDiskResources (Total Keys: 2) - schemas.Instance.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.InstanceProperties.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.PersistentDiskResourceCommitment (Total Keys: 6) - schemas.RegexRewrite (Total Keys: 4) - schemas.ReliabilityRisk (Total Keys: 35) - schemas.RiskDetails (Total Keys: 18) - schemas.RiskRecommendation (Total Keys: 3) - schemas.Subnetwork.properties.ipv6NetworkTier.type (Total Keys: 1) #### compute:v1 The following keys were added: - resources.instanceGroupManagers.methods.delete.parameters.noGracefulShutdown (Total Keys: 3) - resources.instanceGroupManagers.methods.deleteInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.instanceGroupManagers.methods.recreateInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.instanceGroupManagers.methods.stopInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.regionInstanceGroupManagers.methods.delete.parameters.noGracefulShutdown (Total Keys: 3) - resources.regionInstanceGroupManagers.methods.deleteInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.regionInstanceGroupManagers.methods.recreateInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.noGracefulShutdown (Total Keys: 3) - resources.routers.methods.deleteNamedSet (Total Keys: 23) - resources.routers.methods.getNamedSet (Total Keys: 20) - resources.routers.methods.listNamedSets (Total Keys: 32) - resources.routers.methods.patchNamedSet (Total Keys: 22) - resources.routers.methods.updateNamedSet (Total Keys: 22) - schemas.Instance.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.InstanceGroupManagerResizeRequest.properties.instances (Total Keys: 2) - schemas.InstanceProperties.properties.localSsdEncryptionMode.type (Total Keys: 1) - schemas.ManagedInstance.properties.scheduling (Total Keys: 2) - schemas.ManagedInstance.properties.shutdownDetails (Total Keys: 2) - schemas.ManagedInstanceScheduling (Total Keys: 8) - schemas.ManagedInstanceShutdownDetails (Total Keys: 7) - schemas.NamedSet (Total Keys: 8) - schemas.RoutersGetNamedSetResponse (Total Keys: 3) - schemas.RoutersListNamedSets (Total Keys: 21) - schemas.SubnetworkSecondaryRange.properties.ipCollection.type (Total Keys: 1) - schemas.SubnetworkSecondaryRange.properties.ipVersion.type (Total Keys: 1) --- ...mpute_alpha.acceleratorPodControllers.html | 1330 ++++++ docs/dyn/compute_alpha.addresses.html | 124 +- docs/dyn/compute_alpha.advice.html | 24 +- docs/dyn/compute_alpha.backendServices.html | 7 +- .../dyn/compute_alpha.dhcpOptionsConfigs.html | 1565 +++++++ docs/dyn/compute_alpha.firewallPolicies.html | 126 +- .../dyn/compute_alpha.futureReservations.html | 150 + docs/dyn/compute_alpha.globalAddresses.html | 93 +- docs/dyn/compute_alpha.html | 10 + .../compute_alpha.instanceGroupManagers.html | 24 +- docs/dyn/compute_alpha.instanceTemplates.html | 84 + docs/dyn/compute_alpha.instances.html | 190 +- docs/dyn/compute_alpha.machineImages.html | 117 + .../dyn/compute_alpha.networkAttachments.html | 50 +- ...compute_alpha.networkFirewallPolicies.html | 144 +- docs/dyn/compute_alpha.networks.html | 18 +- .../compute_alpha.regionBackendServices.html | 8 +- ...ute_alpha.regionInstanceGroupManagers.html | 24 +- ...compute_alpha.regionInstanceTemplates.html | 63 + docs/dyn/compute_alpha.regionInstances.html | 21 + ...e_alpha.regionNetworkFirewallPolicies.html | 117 +- docs/dyn/compute_alpha.reliabilityRisks.html | 34 +- docs/dyn/compute_alpha.routers.html | 1 + .../dyn/compute_alpha.targetHttpsProxies.html | 3 +- docs/dyn/compute_alpha.targetSslProxies.html | 3 +- .../compute_alpha.zoneQueuedResources.html | 84 + docs/dyn/compute_beta.addresses.html | 124 +- docs/dyn/compute_beta.advice.html | 24 +- docs/dyn/compute_beta.backendServices.html | 7 +- docs/dyn/compute_beta.firewallPolicies.html | 126 +- docs/dyn/compute_beta.globalAddresses.html | 93 +- docs/dyn/compute_beta.html | 5 + .../compute_beta.instanceGroupManagers.html | 21 +- docs/dyn/compute_beta.instanceTemplates.html | 8 + docs/dyn/compute_beta.instances.html | 30 +- docs/dyn/compute_beta.machineImages.html | 6 + docs/dyn/compute_beta.networkAttachments.html | 50 +- .../compute_beta.networkFirewallPolicies.html | 144 +- docs/dyn/compute_beta.networks.html | 18 +- .../compute_beta.regionBackendServices.html | 8 +- docs/dyn/compute_beta.regionCommitments.html | 50 + ...pute_beta.regionInstanceGroupManagers.html | 21 +- .../compute_beta.regionInstanceTemplates.html | 6 + docs/dyn/compute_beta.regionInstances.html | 2 + ...te_beta.regionNetworkFirewallPolicies.html | 117 +- docs/dyn/compute_beta.regionUrlMaps.html | 672 +++ docs/dyn/compute_beta.reliabilityRisks.html | 328 ++ docs/dyn/compute_beta.subnetworks.html | 20 + docs/dyn/compute_beta.targetHttpsProxies.html | 3 +- docs/dyn/compute_beta.targetSslProxies.html | 3 +- docs/dyn/compute_beta.urlMaps.html | 784 ++++ docs/dyn/compute_v1.addresses.html | 124 +- docs/dyn/compute_v1.backendServices.html | 7 +- docs/dyn/compute_v1.firewallPolicies.html | 99 +- docs/dyn/compute_v1.globalAddresses.html | 93 +- ...v1.instanceGroupManagerResizeRequests.html | 213 + .../dyn/compute_v1.instanceGroupManagers.html | 50 +- docs/dyn/compute_v1.instanceTemplates.html | 8 + docs/dyn/compute_v1.instances.html | 30 +- docs/dyn/compute_v1.machineImages.html | 6 + docs/dyn/compute_v1.networkAttachments.html | 50 +- .../compute_v1.networkFirewallPolicies.html | 144 +- docs/dyn/compute_v1.networks.html | 18 +- .../dyn/compute_v1.regionBackendServices.html | 8 +- ...ionInstanceGroupManagerResizeRequests.html | 213 + ...ompute_v1.regionInstanceGroupManagers.html | 50 +- .../compute_v1.regionInstanceTemplates.html | 6 + docs/dyn/compute_v1.regionInstances.html | 2 + ...pute_v1.regionNetworkFirewallPolicies.html | 117 +- docs/dyn/compute_v1.routers.html | 3662 +++++++++++------ docs/dyn/compute_v1.subnetworks.html | 40 + docs/dyn/compute_v1.targetHttpsProxies.html | 3 +- docs/dyn/compute_v1.targetSslProxies.html | 3 +- .../documents/compute.alpha.json | 2024 +++++++-- .../documents/compute.beta.json | 559 ++- .../discovery_cache/documents/compute.v1.json | 650 ++- 76 files changed, 12899 insertions(+), 2364 deletions(-) create mode 100644 docs/dyn/compute_alpha.acceleratorPodControllers.html create mode 100644 docs/dyn/compute_alpha.dhcpOptionsConfigs.html create mode 100644 docs/dyn/compute_beta.reliabilityRisks.html diff --git a/docs/dyn/compute_alpha.acceleratorPodControllers.html b/docs/dyn/compute_alpha.acceleratorPodControllers.html new file mode 100644 index 0000000000..3b9fda97fe --- /dev/null +++ b/docs/dyn/compute_alpha.acceleratorPodControllers.html @@ -0,0 +1,1330 @@ + + + +

Compute Engine API . acceleratorPodControllers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, resourceId, requestId=None, x__xgafv=None)

+

Deletes the specified AcceleratorPodController resource.

+

+ get(project, zone, resourceId, x__xgafv=None)

+

Gets the specified AcceleratorPodController resource.

+

+ insert(project, zone, body=None, requestId=None, x__xgafv=None)

+

Inserts a new AcceleratorPodController resource.

+

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the AcceleratorPodController resources in the specified zone.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, zone, resourceId, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Patches the specified AcceleratorPodController resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, resourceId, requestId=None, x__xgafv=None) +
Deletes the specified AcceleratorPodController resource.
+
+Args:
+  project: string, A parameter (required)
+  zone: string, A parameter (required)
+  resourceId: string, A parameter (required)
+  requestId: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, zone, resourceId, x__xgafv=None) +
Gets the specified AcceleratorPodController resource.
+
+Args:
+  project: string, A parameter (required)
+  zone: string, A parameter (required)
+  resourceId: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a controller for managing out-of-band access to an accelerator
+    # domain (e.g., NVLink Domain).
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "A String",
+  "managementInterfaces": { # Map of management interfaces. Keys must be valid RFC1035 names and at most
+      # 63 characters long.
+    "a_key": { # Represents a managed interface for an accelerator domain.
+        # It defines the network endpoint and authentication configuration needed to
+        # access specific management services like NMX-C or gNMI.
+      "authenticationConfig": { # Authentication configuration for the management interface, typically using
+          # mTLS.
+        "trustConfig": "A String", # Required. Resource name of the Cloud Certificate Manager TrustConfig used to validate
+            # client certificates for mTLS.
+            # Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+      },
+      "ipv4Address": "A String", # The IPv4 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface.
+      "ipv6Address": "A String", # The IPv6 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface if IPv6 is supported and configured.
+      "network": "A String", # The URL of the VPC network to which the management interface endpoint is
+          # attached. The customer must ensure that this network is correctly
+          # configured for routing to the accelerator domain.
+      "state": "A String",
+      "subnetwork": "A String", # The URL of the subnetwork from which to assign the IP address for the
+          # endpoint. The subnetwork must belong to the specified network and have
+          # available IP addresses.
+      "type": "A String", # Required. The type of management service this interface provides.
+          # Supported types include NMX-C for partition management and gNMI for switch
+          # monitoring.
+    },
+  },
+  "name": "A String", # Required. The name of the resource, provided by the client when initially creating
+      # the resource. The resource name must be 1-63 characters long, and comply
+      # withRFC1035.
+      # Specifically, the name must match the regular expression
+      # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+      # lowercase letter, and all following characters must be a dash, lowercase
+      # letter, or digit, except the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for the resource with the resource ID.
+  "target": "A String", # Required. The target accelerator domain this controller manages.
+      # This must be a resolvable identifier for the specific NVLink Domain or
+      # TPU system (e.g., a Reservation Sub-block URI).
+      # Example:
+      # "projects/my-project/reservations/my-reservation/subBlocks/subblock-1".
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the accelerator pod controller resides.
+}
+
+ +
+ insert(project, zone, body=None, requestId=None, x__xgafv=None) +
Inserts a new AcceleratorPodController resource.
+
+Args:
+  project: string, A parameter (required)
+  zone: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a controller for managing out-of-band access to an accelerator
+    # domain (e.g., NVLink Domain).
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "A String",
+  "managementInterfaces": { # Map of management interfaces. Keys must be valid RFC1035 names and at most
+      # 63 characters long.
+    "a_key": { # Represents a managed interface for an accelerator domain.
+        # It defines the network endpoint and authentication configuration needed to
+        # access specific management services like NMX-C or gNMI.
+      "authenticationConfig": { # Authentication configuration for the management interface, typically using
+          # mTLS.
+        "trustConfig": "A String", # Required. Resource name of the Cloud Certificate Manager TrustConfig used to validate
+            # client certificates for mTLS.
+            # Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+      },
+      "ipv4Address": "A String", # The IPv4 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface.
+      "ipv6Address": "A String", # The IPv6 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface if IPv6 is supported and configured.
+      "network": "A String", # The URL of the VPC network to which the management interface endpoint is
+          # attached. The customer must ensure that this network is correctly
+          # configured for routing to the accelerator domain.
+      "state": "A String",
+      "subnetwork": "A String", # The URL of the subnetwork from which to assign the IP address for the
+          # endpoint. The subnetwork must belong to the specified network and have
+          # available IP addresses.
+      "type": "A String", # Required. The type of management service this interface provides.
+          # Supported types include NMX-C for partition management and gNMI for switch
+          # monitoring.
+    },
+  },
+  "name": "A String", # Required. The name of the resource, provided by the client when initially creating
+      # the resource. The resource name must be 1-63 characters long, and comply
+      # withRFC1035.
+      # Specifically, the name must match the regular expression
+      # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+      # lowercase letter, and all following characters must be a dash, lowercase
+      # letter, or digit, except the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for the resource with the resource ID.
+  "target": "A String", # Required. The target accelerator domain this controller manages.
+      # This must be a resolvable identifier for the specific NVLink Domain or
+      # TPU system (e.g., a Reservation Sub-block URI).
+      # Example:
+      # "projects/my-project/reservations/my-reservation/subBlocks/subblock-1".
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the accelerator pod controller resides.
+}
+
+  requestId: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the AcceleratorPodController resources in the specified zone.
+
+Args:
+  project: string, A parameter (required)
+  zone: string, A parameter (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "items": [
+    { # Represents a controller for managing out-of-band access to an accelerator
+        # domain (e.g., NVLink Domain).
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format.
+      "description": "A String", # An optional description of this resource.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "A String",
+      "managementInterfaces": { # Map of management interfaces. Keys must be valid RFC1035 names and at most
+          # 63 characters long.
+        "a_key": { # Represents a managed interface for an accelerator domain.
+            # It defines the network endpoint and authentication configuration needed to
+            # access specific management services like NMX-C or gNMI.
+          "authenticationConfig": { # Authentication configuration for the management interface, typically using
+              # mTLS.
+            "trustConfig": "A String", # Required. Resource name of the Cloud Certificate Manager TrustConfig used to validate
+                # client certificates for mTLS.
+                # Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+          },
+          "ipv4Address": "A String", # The IPv4 internal IP address assigned to this management interface
+              # endpoint. This address will be used by the customer to route traffic to the
+              # management interface.
+          "ipv6Address": "A String", # The IPv6 internal IP address assigned to this management interface
+              # endpoint. This address will be used by the customer to route traffic to the
+              # management interface if IPv6 is supported and configured.
+          "network": "A String", # The URL of the VPC network to which the management interface endpoint is
+              # attached. The customer must ensure that this network is correctly
+              # configured for routing to the accelerator domain.
+          "state": "A String",
+          "subnetwork": "A String", # The URL of the subnetwork from which to assign the IP address for the
+              # endpoint. The subnetwork must belong to the specified network and have
+              # available IP addresses.
+          "type": "A String", # Required. The type of management service this interface provides.
+              # Supported types include NMX-C for partition management and gNMI for switch
+              # monitoring.
+        },
+      },
+      "name": "A String", # Required. The name of the resource, provided by the client when initially creating
+          # the resource. The resource name must be 1-63 characters long, and comply
+          # withRFC1035.
+          # Specifically, the name must match the regular expression
+          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+          # lowercase letter, and all following characters must be a dash, lowercase
+          # letter, or digit, except the last character, which cannot be a dash.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for the resource with the resource ID.
+      "target": "A String", # Required. The target accelerator domain this controller manages.
+          # This must be a resolvable identifier for the specific NVLink Domain or
+          # TPU system (e.g., a Reservation Sub-block URI).
+          # Example:
+          # "projects/my-project/reservations/my-reservation/subBlocks/subblock-1".
+      "zone": "A String", # Output only. [Output Only] URL of the zone where the accelerator pod controller resides.
+    },
+  ],
+  "kind": "A String",
+  "nextPageToken": "A String",
+  "selfLink": "A String",
+  "warning": {
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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(project, zone, resourceId, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Patches the specified AcceleratorPodController resource.
+
+Args:
+  project: string, A parameter (required)
+  zone: string, A parameter (required)
+  resourceId: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a controller for managing out-of-band access to an accelerator
+    # domain (e.g., NVLink Domain).
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "A String",
+  "managementInterfaces": { # Map of management interfaces. Keys must be valid RFC1035 names and at most
+      # 63 characters long.
+    "a_key": { # Represents a managed interface for an accelerator domain.
+        # It defines the network endpoint and authentication configuration needed to
+        # access specific management services like NMX-C or gNMI.
+      "authenticationConfig": { # Authentication configuration for the management interface, typically using
+          # mTLS.
+        "trustConfig": "A String", # Required. Resource name of the Cloud Certificate Manager TrustConfig used to validate
+            # client certificates for mTLS.
+            # Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}
+      },
+      "ipv4Address": "A String", # The IPv4 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface.
+      "ipv6Address": "A String", # The IPv6 internal IP address assigned to this management interface
+          # endpoint. This address will be used by the customer to route traffic to the
+          # management interface if IPv6 is supported and configured.
+      "network": "A String", # The URL of the VPC network to which the management interface endpoint is
+          # attached. The customer must ensure that this network is correctly
+          # configured for routing to the accelerator domain.
+      "state": "A String",
+      "subnetwork": "A String", # The URL of the subnetwork from which to assign the IP address for the
+          # endpoint. The subnetwork must belong to the specified network and have
+          # available IP addresses.
+      "type": "A String", # Required. The type of management service this interface provides.
+          # Supported types include NMX-C for partition management and gNMI for switch
+          # monitoring.
+    },
+  },
+  "name": "A String", # Required. The name of the resource, provided by the client when initially creating
+      # the resource. The resource name must be 1-63 characters long, and comply
+      # withRFC1035.
+      # Specifically, the name must match the regular expression
+      # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+      # lowercase letter, and all following characters must be a dash, lowercase
+      # letter, or digit, except the last character, which cannot be a dash.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for the resource with the resource ID.
+  "target": "A String", # Required. The target accelerator domain this controller manages.
+      # This must be a resolvable identifier for the specific NVLink Domain or
+      # TPU system (e.g., a Reservation Sub-block URI).
+      # Example:
+      # "projects/my-project/reservations/my-reservation/subBlocks/subblock-1".
+  "zone": "A String", # Output only. [Output Only] URL of the zone where the accelerator pod controller resides.
+}
+
+  requestId: string, A parameter
+  updateMask: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html index d72841d2c4..3859bc69f1 100644 --- a/docs/dyn/compute_alpha.addresses.html +++ b/docs/dyn/compute_alpha.addresses.html @@ -241,21 +241,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -750,21 +763,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -875,21 +901,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1376,21 +1415,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html index 64dd2b0333..581ced68e6 100644 --- a/docs/dyn/compute_alpha.advice.html +++ b/docs/dyn/compute_alpha.advice.html @@ -372,11 +372,12 @@

Method Details

An object of the form: { # Contains the capacity history. - "location": "A String", - "machineType": "A String", - "preemptionHistory": [ - { - "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + "location": "A String", # Output only. The location (region or zone) for which the capacity history is returned. + # It is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone. + "machineType": "A String", # The machine type for which the capacity history is returned. + "preemptionHistory": [ # The preemption history for the requested machine type and location. + { # A record of Spot VM preemption history. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this preemption record. # Timestamp end (exclusive). # # The start must be less than or equal to the end. @@ -391,12 +392,15 @@

Method Details

# If specified, a Timestamp matching this interval will have to be the same # or after the start. }, - "preemptionRate": 3.14, + "preemptionRate": 3.14, # The preemption rate during the interval, representing the fraction of + # Spot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is + # calculated as (total preempted Spots) / (total Spots that stopped + # running). }, ], - "priceHistory": [ - { - "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + "priceHistory": [ # The price history for the requested machine type and location. + { # A record of price history. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this price record. # Timestamp end (exclusive). # # The start must be less than or equal to the end. @@ -411,7 +415,7 @@

Method Details

# If specified, a Timestamp matching this interval will have to be the same # or after the start. }, - "listPrice": { # Represents an amount of money with its currency type. + "listPrice": { # Represents an amount of money with its currency type. # The Spot VM list price during the interval. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. # The value must be between -999,999,999 and +999,999,999 inclusive. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 7e8f9898e2..992e12061f 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -112,7 +112,7 @@

Instance Methods

Retrieves the list of BackendService resources available to the specified

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project.

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -9930,7 +9930,10 @@

Method Details

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project.
+Backend services for external and internal passthrough Network Load
+Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.dhcpOptionsConfigs.html b/docs/dyn/compute_alpha.dhcpOptionsConfigs.html
new file mode 100644
index 0000000000..18e6137c4d
--- /dev/null
+++ b/docs/dyn/compute_alpha.dhcpOptionsConfigs.html
@@ -0,0 +1,1565 @@
+
+
+
+

Compute Engine API . dhcpOptionsConfigs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, dhcpOptionsConfig, requestId=None, x__xgafv=None)

+

Deletes the specified DhcpOptionsConfig in the given location

+

+ get(project, region, dhcpOptionsConfig, x__xgafv=None)

+

Returns the specified DhcpOptionsConfig resource in the given location.

+

+ insert(project, region, body=None, requestId=None, x__xgafv=None)

+

Creates a DhcpOptionsConfig in the specified project in the given location

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Lists the DhcpOptionsConfigs for a project in the given location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(project, region, dhcpOptionsConfig, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Patches the specified DhcpOptionsConfig resource with the data included in

+

+ testIamPermissions(project, region, resource, body=None, x__xgafv=None)

+

Returns permissions that a caller has on the specified resource.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, dhcpOptionsConfig, requestId=None, x__xgafv=None) +
Deletes the specified DhcpOptionsConfig in the given location
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  dhcpOptionsConfig: string, Name of the DhcpOptionsConfig resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+end_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, dhcpOptionsConfig, x__xgafv=None) +
Returns the specified DhcpOptionsConfig resource in the given location.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  dhcpOptionsConfig: string, Name of the DhcpOptionsConfig resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A standalone, regional API resource that encapsulates a set of user-defined
+    # DHCP configurations.
+  "associations": { # Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
+    "a_key": { # Association represents the relationship between a DHCP options config and a
+        # network. Association represents the relationship between a DHCP options
+        # config and a network.
+      "network": "A String", # Required. The target network this DHCP option is attached to.
+          # You can specify this as a full or partial URL. For example, the following
+          # are all valid URLs:
+          #
+          #
+          #      - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+          #
+          #      - projects/project/global/networks/network
+      "networkId": "A String", # Output only. [Output Only] The server-defined ID of the associated Network.
+      "state": "A String", # Output only. [Output Only] State of the association.
+    },
+  },
+  "bootFileIpv4Name": "A String", # The file path and name of the boot image/file on the TFTP server that the
+      # client VM guest OS should download and execute during network boot. Used
+      # when the standard DHCP header 'file' field is overloaded. Corresponds to
+      # DHCPv4 Option 67.
+  "bootFileIpv6Parameters": [ # A list of UTF-8 encoded parameter strings to be passed as arguments to the
+      # bootloader program or OS kernel after downloading the boot file.
+      # Corresponds to DHCPv6 Option 60.
+    "A String",
+  ],
+  "bootFileIpv6Url": "A String", # The Uniform Resource Locator (URL) specifying the protocol, server address,
+      # and file path of the boot file that the client VM guest OS should download
+      # and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or
+      # 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "dnsSearchPaths": [ # An ordered list of domain suffixes (search paths) that the client VM guest
+      # OS should append to resolve hostnames that are not fully qualified. Applies
+      # to both DHCPv4 Option 119 and DHCPv6 Option 24.
+    "A String",
+  ],
+  "dnsServerIpv4Addresses": [ # An ordered list of IPv4 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv4 Option 6.
+    "A String",
+  ],
+  "dnsServerIpv6Addresses": [ # An ordered list of IPv6 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv6 Option 23.
+    "A String",
+  ],
+  "domainName": "A String", # The domain name that the client VM guest OS should use when resolving
+      # hostnames via DNS (e.g., 'example.com'). It defines the default domain
+      # suffix for the client. Corresponds to DHCPv4 Option 15.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server
+      # generates this identifier.
+  "kind": "compute#dhcpOptionsConfig", # Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.
+  "leaseTimeSec": "A String", # The duration, in seconds, of the IPv4 address lease offered by the DHCP
+      # server to the client VM guest OS. Corresponds to DHCPv4 Option 51.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "ntpServerIpv4Addresses": [ # An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization,
+      # listed in order of preference. Corresponds to DHCPv4 Option 42.
+    "A String",
+  ],
+  "ntpServerIpv6Addresses": [ # An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization.
+      # Corresponds to DHCPv6 Option 56.
+    "A String",
+  ],
+  "region": "A String", # Output only. [Output Only] URL of the region where the resource resides.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "tftpServerIpv4Addresses": [ # An ordered list of one or more IPv4 addresses of TFTP servers. Provides
+      # server redundancy and failover support, and is generally prioritized by
+      # clients over the single hostname specified in Option 66. Corresponds to
+      # DHCPv4 Option 150.
+    "A String",
+  ],
+  "tftpServerIpv4Name": "A String", # The hostname or IP address of the Trivial File Transfer Protocol (TFTP)
+      # server from which the client VM guest OS can download boot files. Typically
+      # used in network booting (PXE) when the standard DHCP header 'sname' field
+      # is overloaded. Corresponds to DHCPv4 Option 66.
+}
+
+ +
+ insert(project, region, body=None, requestId=None, x__xgafv=None) +
Creates a DhcpOptionsConfig in the specified project in the given location
+using the parameters that are included in the request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A standalone, regional API resource that encapsulates a set of user-defined
+    # DHCP configurations.
+  "associations": { # Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
+    "a_key": { # Association represents the relationship between a DHCP options config and a
+        # network. Association represents the relationship between a DHCP options
+        # config and a network.
+      "network": "A String", # Required. The target network this DHCP option is attached to.
+          # You can specify this as a full or partial URL. For example, the following
+          # are all valid URLs:
+          #
+          #
+          #      - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+          #
+          #      - projects/project/global/networks/network
+      "networkId": "A String", # Output only. [Output Only] The server-defined ID of the associated Network.
+      "state": "A String", # Output only. [Output Only] State of the association.
+    },
+  },
+  "bootFileIpv4Name": "A String", # The file path and name of the boot image/file on the TFTP server that the
+      # client VM guest OS should download and execute during network boot. Used
+      # when the standard DHCP header 'file' field is overloaded. Corresponds to
+      # DHCPv4 Option 67.
+  "bootFileIpv6Parameters": [ # A list of UTF-8 encoded parameter strings to be passed as arguments to the
+      # bootloader program or OS kernel after downloading the boot file.
+      # Corresponds to DHCPv6 Option 60.
+    "A String",
+  ],
+  "bootFileIpv6Url": "A String", # The Uniform Resource Locator (URL) specifying the protocol, server address,
+      # and file path of the boot file that the client VM guest OS should download
+      # and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or
+      # 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "dnsSearchPaths": [ # An ordered list of domain suffixes (search paths) that the client VM guest
+      # OS should append to resolve hostnames that are not fully qualified. Applies
+      # to both DHCPv4 Option 119 and DHCPv6 Option 24.
+    "A String",
+  ],
+  "dnsServerIpv4Addresses": [ # An ordered list of IPv4 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv4 Option 6.
+    "A String",
+  ],
+  "dnsServerIpv6Addresses": [ # An ordered list of IPv6 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv6 Option 23.
+    "A String",
+  ],
+  "domainName": "A String", # The domain name that the client VM guest OS should use when resolving
+      # hostnames via DNS (e.g., 'example.com'). It defines the default domain
+      # suffix for the client. Corresponds to DHCPv4 Option 15.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server
+      # generates this identifier.
+  "kind": "compute#dhcpOptionsConfig", # Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.
+  "leaseTimeSec": "A String", # The duration, in seconds, of the IPv4 address lease offered by the DHCP
+      # server to the client VM guest OS. Corresponds to DHCPv4 Option 51.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "ntpServerIpv4Addresses": [ # An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization,
+      # listed in order of preference. Corresponds to DHCPv4 Option 42.
+    "A String",
+  ],
+  "ntpServerIpv6Addresses": [ # An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization.
+      # Corresponds to DHCPv6 Option 56.
+    "A String",
+  ],
+  "region": "A String", # Output only. [Output Only] URL of the region where the resource resides.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "tftpServerIpv4Addresses": [ # An ordered list of one or more IPv4 addresses of TFTP servers. Provides
+      # server redundancy and failover support, and is generally prioritized by
+      # clients over the single hostname specified in Option 66. Corresponds to
+      # DHCPv4 Option 150.
+    "A String",
+  ],
+  "tftpServerIpv4Name": "A String", # The hostname or IP address of the Trivial File Transfer Protocol (TFTP)
+      # server from which the client VM guest OS can download boot files. Typically
+      # used in network booting (PXE) when the standard DHCP header 'sname' field
+      # is overloaded. Corresponds to DHCPv4 Option 66.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+end_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Lists the DhcpOptionsConfigs for a project in the given location.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region of this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "etag": "A String", # Server-defined ETag for optimistic concurrency control.
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of DhcpOptionsConfig resources.
+    { # A standalone, regional API resource that encapsulates a set of user-defined
+        # DHCP configurations.
+      "associations": { # Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
+        "a_key": { # Association represents the relationship between a DHCP options config and a
+            # network. Association represents the relationship between a DHCP options
+            # config and a network.
+          "network": "A String", # Required. The target network this DHCP option is attached to.
+              # You can specify this as a full or partial URL. For example, the following
+              # are all valid URLs:
+              #
+              #
+              #      - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+              #
+              #      - projects/project/global/networks/network
+          "networkId": "A String", # Output only. [Output Only] The server-defined ID of the associated Network.
+          "state": "A String", # Output only. [Output Only] State of the association.
+        },
+      },
+      "bootFileIpv4Name": "A String", # The file path and name of the boot image/file on the TFTP server that the
+          # client VM guest OS should download and execute during network boot. Used
+          # when the standard DHCP header 'file' field is overloaded. Corresponds to
+          # DHCPv4 Option 67.
+      "bootFileIpv6Parameters": [ # A list of UTF-8 encoded parameter strings to be passed as arguments to the
+          # bootloader program or OS kernel after downloading the boot file.
+          # Corresponds to DHCPv6 Option 60.
+        "A String",
+      ],
+      "bootFileIpv6Url": "A String", # The Uniform Resource Locator (URL) specifying the protocol, server address,
+          # and file path of the boot file that the client VM guest OS should download
+          # and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or
+          # 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+          # text format.
+      "description": "A String", # An optional description of this resource. Provide this property when you
+          # create the resource.
+      "dnsSearchPaths": [ # An ordered list of domain suffixes (search paths) that the client VM guest
+          # OS should append to resolve hostnames that are not fully qualified. Applies
+          # to both DHCPv4 Option 119 and DHCPv6 Option 24.
+        "A String",
+      ],
+      "dnsServerIpv4Addresses": [ # An ordered list of IPv4 addresses of DNS recursive name servers available
+          # to the client VM guest OS, specified in order of preference. Corresponds to
+          # DHCPv4 Option 6.
+        "A String",
+      ],
+      "dnsServerIpv6Addresses": [ # An ordered list of IPv6 addresses of DNS recursive name servers available
+          # to the client VM guest OS, specified in order of preference. Corresponds to
+          # DHCPv6 Option 23.
+        "A String",
+      ],
+      "domainName": "A String", # The domain name that the client VM guest OS should use when resolving
+          # hostnames via DNS (e.g., 'example.com'). It defines the default domain
+          # suffix for the client. Corresponds to DHCPv4 Option 15.
+      "id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server
+          # generates this identifier.
+      "kind": "compute#dhcpOptionsConfig", # Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.
+      "leaseTimeSec": "A String", # The duration, in seconds, of the IPv4 address lease offered by the DHCP
+          # server to the client VM guest OS. Corresponds to DHCPv4 Option 51.
+      "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+          # The name must be 1-63 characters long, and comply withRFC1035.
+          # Specifically, the name must be 1-63 characters long and match the regular
+          # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+          # character must be a lowercase letter, and all following characters must
+          # be a dash, lowercase letter, or digit, except the last character, which
+          # cannot be a dash.
+      "ntpServerIpv4Addresses": [ # An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers
+          # available to the client VM guest OS for system clock synchronization,
+          # listed in order of preference. Corresponds to DHCPv4 Option 42.
+        "A String",
+      ],
+      "ntpServerIpv6Addresses": [ # An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers
+          # available to the client VM guest OS for system clock synchronization.
+          # Corresponds to DHCPv6 Option 56.
+        "A String",
+      ],
+      "region": "A String", # Output only. [Output Only] URL of the region where the resource resides.
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "tftpServerIpv4Addresses": [ # An ordered list of one or more IPv4 addresses of TFTP servers. Provides
+          # server redundancy and failover support, and is generally prioritized by
+          # clients over the single hostname specified in Option 66. Corresponds to
+          # DHCPv4 Option 150.
+        "A String",
+      ],
+      "tftpServerIpv4Name": "A String", # The hostname or IP address of the Trivial File Transfer Protocol (TFTP)
+          # server from which the client VM guest OS can download boot files. Typically
+          # used in network booting (PXE) when the standard DHCP header 'sname' field
+          # is overloaded. Corresponds to DHCPv4 Option 66.
+    },
+  ],
+  "kind": "compute#dhcpOptionsConfigList", # Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfigList for a list of dhcp options
+      # configs.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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(project, region, dhcpOptionsConfig, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Patches the specified DhcpOptionsConfig resource with the data included in
+the request. This method supports PATCH
+semantics and usesJSON merge
+patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  dhcpOptionsConfig: string, Name of the DhcpOptionsConfig resource to patch. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A standalone, regional API resource that encapsulates a set of user-defined
+    # DHCP configurations.
+  "associations": { # Mapping of user-defined keys to DhcpOptionsConfig to Network associations.
+    "a_key": { # Association represents the relationship between a DHCP options config and a
+        # network. Association represents the relationship between a DHCP options
+        # config and a network.
+      "network": "A String", # Required. The target network this DHCP option is attached to.
+          # You can specify this as a full or partial URL. For example, the following
+          # are all valid URLs:
+          #
+          #
+          #      - https://www.googleapis.com/compute/v1/projects/project/global/networks/network
+          #
+          #      - projects/project/global/networks/network
+      "networkId": "A String", # Output only. [Output Only] The server-defined ID of the associated Network.
+      "state": "A String", # Output only. [Output Only] State of the association.
+    },
+  },
+  "bootFileIpv4Name": "A String", # The file path and name of the boot image/file on the TFTP server that the
+      # client VM guest OS should download and execute during network boot. Used
+      # when the standard DHCP header 'file' field is overloaded. Corresponds to
+      # DHCPv4 Option 67.
+  "bootFileIpv6Parameters": [ # A list of UTF-8 encoded parameter strings to be passed as arguments to the
+      # bootloader program or OS kernel after downloading the boot file.
+      # Corresponds to DHCPv6 Option 60.
+    "A String",
+  ],
+  "bootFileIpv6Url": "A String", # The Uniform Resource Locator (URL) specifying the protocol, server address,
+      # and file path of the boot file that the client VM guest OS should download
+      # and execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or
+      # 'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "dnsSearchPaths": [ # An ordered list of domain suffixes (search paths) that the client VM guest
+      # OS should append to resolve hostnames that are not fully qualified. Applies
+      # to both DHCPv4 Option 119 and DHCPv6 Option 24.
+    "A String",
+  ],
+  "dnsServerIpv4Addresses": [ # An ordered list of IPv4 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv4 Option 6.
+    "A String",
+  ],
+  "dnsServerIpv6Addresses": [ # An ordered list of IPv6 addresses of DNS recursive name servers available
+      # to the client VM guest OS, specified in order of preference. Corresponds to
+      # DHCPv6 Option 23.
+    "A String",
+  ],
+  "domainName": "A String", # The domain name that the client VM guest OS should use when resolving
+      # hostnames via DNS (e.g., 'example.com'). It defines the default domain
+      # suffix for the client. Corresponds to DHCPv4 Option 15.
+  "id": "A String", # Output only. [Output Only] The unique identifier for the resource type. The server
+      # generates this identifier.
+  "kind": "compute#dhcpOptionsConfig", # Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.
+  "leaseTimeSec": "A String", # The duration, in seconds, of the IPv4 address lease offered by the DHCP
+      # server to the client VM guest OS. Corresponds to DHCPv4 Option 51.
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "ntpServerIpv4Addresses": [ # An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization,
+      # listed in order of preference. Corresponds to DHCPv4 Option 42.
+    "A String",
+  ],
+  "ntpServerIpv6Addresses": [ # An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers
+      # available to the client VM guest OS for system clock synchronization.
+      # Corresponds to DHCPv6 Option 56.
+    "A String",
+  ],
+  "region": "A String", # Output only. [Output Only] URL of the region where the resource resides.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "tftpServerIpv4Addresses": [ # An ordered list of one or more IPv4 addresses of TFTP servers. Provides
+      # server redundancy and failover support, and is generally prioritized by
+      # clients over the single hostname specified in Option 66. Corresponds to
+      # DHCPv4 Option 150.
+    "A String",
+  ],
+  "tftpServerIpv4Name": "A String", # The hostname or IP address of the Trivial File Transfer Protocol (TFTP)
+      # server from which the client VM guest OS can download boot files. Typically
+      # used in network booting (PXE) when the standard DHCP header 'sname' field
+      # is overloaded. Corresponds to DHCPv4 Option 66.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+end_interface: MixerMutationRequestBuilder
+  updateMask: string, update_mask indicates fields to be updated as part of this request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/alpha/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
+    },
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
+          #
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ testIamPermissions(project, region, resource, body=None, x__xgafv=None) +
Returns permissions that a caller has on the specified resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "permissions": [ # The set of permissions to check for the 'resource'. Permissions with
+      # wildcards (such as '*' or 'storage.*') are not allowed.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+      # allowed.
+    "A String",
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html index ea0b56dd1e..00abbbcbe9 100644 --- a/docs/dyn/compute_alpha.firewallPolicies.html +++ b/docs/dyn/compute_alpha.firewallPolicies.html @@ -476,7 +476,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -609,11 +611,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -957,7 +960,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1090,11 +1095,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2361,7 +2367,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2494,11 +2502,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2612,7 +2621,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2745,11 +2756,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3237,7 +3249,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3370,11 +3384,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3439,7 +3454,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3572,11 +3589,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3683,7 +3701,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3816,11 +3836,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3934,7 +3955,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4067,11 +4090,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4585,7 +4609,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4718,11 +4744,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4836,7 +4863,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4969,11 +4998,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5487,7 +5517,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5620,11 +5652,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5738,7 +5771,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5871,11 +5906,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6244,7 +6280,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6377,11 +6415,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6726,7 +6765,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6859,11 +6900,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html index ca420aa9e5..a5eca39e33 100644 --- a/docs/dyn/compute_alpha.futureReservations.html +++ b/docs/dyn/compute_alpha.futureReservations.html @@ -339,6 +339,9 @@

Method Details

# does not exist already, it is created automatically at the time of Approval # with INACTIVE state till specified start-time. Either provide the # reservation_name or a name_prefix. + "resourceName": "A String", # Name of the resource intended to be delivered. Name should conform to + # RFC1035. This will be the name of storage pool or Exapool for persistent + # disk FRs. "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. @@ -418,6 +421,11 @@

Method Details

# start_time. "A String", ], + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. Exapool provisioned capacities for each SKU type. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, "existingMatchingUsageInfo": { # [Output Only] Represents the existing matching usage for the future # Output only. [Output Only] Represents the existing matching usage for the future # reservation. # reservation. @@ -546,6 +554,28 @@

Method Details

"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate the Future Reservation # properties. }, + "storagePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Output only. Storage pool provisioned capacities for each SKU type. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + }, + "storagePoolProperties": { # Storage pool properties for the future reservation. # Storage pool details for the future reservation. + "requestedExapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Requested exapool provisioned capacity in GiB. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, + "requestedStoragePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Requested storage pool provisioned capacity. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + "storagePoolType": "A String", # Type of the storage pool. }, "timeWindow": { # Time window for this Future Reservation. "duration": { # A Duration represents a fixed-length span of time represented @@ -1376,6 +1406,9 @@

Method Details

# does not exist already, it is created automatically at the time of Approval # with INACTIVE state till specified start-time. Either provide the # reservation_name or a name_prefix. + "resourceName": "A String", # Name of the resource intended to be delivered. Name should conform to + # RFC1035. This will be the name of storage pool or Exapool for persistent + # disk FRs. "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. @@ -1455,6 +1488,11 @@

Method Details

# start_time. "A String", ], + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. Exapool provisioned capacities for each SKU type. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, "existingMatchingUsageInfo": { # [Output Only] Represents the existing matching usage for the future # Output only. [Output Only] Represents the existing matching usage for the future # reservation. # reservation. @@ -1583,6 +1621,28 @@

Method Details

"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate the Future Reservation # properties. }, + "storagePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Output only. Storage pool provisioned capacities for each SKU type. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + }, + "storagePoolProperties": { # Storage pool properties for the future reservation. # Storage pool details for the future reservation. + "requestedExapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Requested exapool provisioned capacity in GiB. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, + "requestedStoragePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Requested storage pool provisioned capacity. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + "storagePoolType": "A String", # Type of the storage pool. }, "timeWindow": { # Time window for this Future Reservation. "duration": { # A Duration represents a fixed-length span of time represented @@ -1734,6 +1794,9 @@

Method Details

# does not exist already, it is created automatically at the time of Approval # with INACTIVE state till specified start-time. Either provide the # reservation_name or a name_prefix. + "resourceName": "A String", # Name of the resource intended to be delivered. Name should conform to + # RFC1035. This will be the name of storage pool or Exapool for persistent + # disk FRs. "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. @@ -1813,6 +1876,11 @@

Method Details

# start_time. "A String", ], + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. Exapool provisioned capacities for each SKU type. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, "existingMatchingUsageInfo": { # [Output Only] Represents the existing matching usage for the future # Output only. [Output Only] Represents the existing matching usage for the future # reservation. # reservation. @@ -1941,6 +2009,28 @@

Method Details

"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate the Future Reservation # properties. }, + "storagePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Output only. Storage pool provisioned capacities for each SKU type. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + }, + "storagePoolProperties": { # Storage pool properties for the future reservation. # Storage pool details for the future reservation. + "requestedExapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Requested exapool provisioned capacity in GiB. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, + "requestedStoragePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Requested storage pool provisioned capacity. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + "storagePoolType": "A String", # Type of the storage pool. }, "timeWindow": { # Time window for this Future Reservation. "duration": { # A Duration represents a fixed-length span of time represented @@ -2471,6 +2561,9 @@

Method Details

# does not exist already, it is created automatically at the time of Approval # with INACTIVE state till specified start-time. Either provide the # reservation_name or a name_prefix. + "resourceName": "A String", # Name of the resource intended to be delivered. Name should conform to + # RFC1035. This will be the name of storage pool or Exapool for persistent + # disk FRs. "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. @@ -2550,6 +2643,11 @@

Method Details

# start_time. "A String", ], + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. Exapool provisioned capacities for each SKU type. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, "existingMatchingUsageInfo": { # [Output Only] Represents the existing matching usage for the future # Output only. [Output Only] Represents the existing matching usage for the future # reservation. # reservation. @@ -2678,6 +2776,28 @@

Method Details

"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate the Future Reservation # properties. }, + "storagePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Output only. Storage pool provisioned capacities for each SKU type. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + }, + "storagePoolProperties": { # Storage pool properties for the future reservation. # Storage pool details for the future reservation. + "requestedExapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Requested exapool provisioned capacity in GiB. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, + "requestedStoragePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Requested storage pool provisioned capacity. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + "storagePoolType": "A String", # Type of the storage pool. }, "timeWindow": { # Time window for this Future Reservation. "duration": { # A Duration represents a fixed-length span of time represented @@ -2882,6 +3002,9 @@

Method Details

# does not exist already, it is created automatically at the time of Approval # with INACTIVE state till specified start-time. Either provide the # reservation_name or a name_prefix. + "resourceName": "A String", # Name of the resource intended to be delivered. Name should conform to + # RFC1035. This will be the name of storage pool or Exapool for persistent + # disk FRs. "schedulingType": "A String", # Maintenance information for this reservation "selfLink": "A String", # Output only. [Output Only] Server-defined fully-qualified URL for this resource. "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id. @@ -2961,6 +3084,11 @@

Method Details

# start_time. "A String", ], + "exapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Output only. Exapool provisioned capacities for each SKU type. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, "existingMatchingUsageInfo": { # [Output Only] Represents the existing matching usage for the future # Output only. [Output Only] Represents the existing matching usage for the future # reservation. # reservation. @@ -3089,6 +3217,28 @@

Method Details

"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate the Future Reservation # properties. }, + "storagePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Output only. Storage pool provisioned capacities for each SKU type. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + }, + "storagePoolProperties": { # Storage pool properties for the future reservation. # Storage pool details for the future reservation. + "requestedExapoolProvisionedCapacityGb": { # Exapool provisioned capacities for each SKU type # Requested exapool provisioned capacity in GiB. + "capacityOptimized": "A String", # Size, in GiB, of provisioned capacity-optimized capacity for this Exapool + "readOptimized": "A String", # Size, in GiB, of provisioned read-optimized capacity for this Exapool + "writeOptimized": "A String", # Size, in GiB, of provisioned write-optimized capacity for this Exapool + }, + "requestedStoragePoolProvisionedCapacity": { # Storage pool provisioned capacities for each SKU type. # Requested storage pool provisioned capacity. + "poolProvisionedCapacityGb": "A String", # Size of the storage pool in GiB. + "poolProvisionedIops": "A String", # Provisioned IOPS of the storage pool. Only relevant if the storage pool + # type is hyperdisk-balanced. + "poolProvisionedThroughput": "A String", # Provisioned throughput of the storage pool in MiB/s. Only relevant if + # the storage pool type is hyperdisk-balanced or hyperdisk-throughput. + }, + "storagePoolType": "A String", # Type of the storage pool. }, "timeWindow": { # Time window for this Future Reservation. "duration": { # A Duration represents a fixed-length span of time represented diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html index d3d740dacc..babd39d918 100644 --- a/docs/dyn/compute_alpha.globalAddresses.html +++ b/docs/dyn/compute_alpha.globalAddresses.html @@ -437,21 +437,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -581,21 +594,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1080,21 +1106,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 9d95349485..92025a9532 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -74,6 +74,11 @@

Compute Engine API

Instance Methods

+

+ acceleratorPodControllers() +

+

Returns the acceleratorPodControllers Resource.

+

acceleratorTypes()

@@ -109,6 +114,11 @@

Instance Methods

Returns the crossSiteNetworks Resource.

+

+ dhcpOptionsConfigs() +

+

Returns the dhcpOptionsConfigs Resource.

+

diskSettings()

diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 8b66686dee..fe511a1380 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -10818,6 +10818,9 @@

Method Details

# Policy. # - TERMINATION_TIMESTAMP Instance reached termination time, # thus managed instance group stops/deletes it. + # - GRACEFUL_SHUTDOWN_TIMESTAMP Instance reached graceful + # shutdown time, thus managed instance group stops/deletes it to + # gracefully shut it down. }, "id": "A String", # Output only. [Output only] The unique identifier for this resource. This field is empty # when instance does not exist. @@ -11987,17 +11990,17 @@

Method Details

# e.g. 'Intel Ice Lake'. "provisioningModel": "A String", # Output only. The provisioning model to be used for this instance. }, - "scheduling": { # Output only. [Output Only] Information about the termination timestamp of the instance, - # if applicable. - "gracefulShutdownTimestamp": "A String", # Output only. [Output Only] The timestamp at which the underlying instance will be + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. - "terminationTimestamp": "A String", # Output only. [Output Only] The timestamp at which the managed instance will be - # terminated. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. }, - "shutdownDetails": { # Output only. [Output Only] Specifies the graceful shutdown details if the instance is in + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in # `PENDING_STOP` state or there is a programmed stop scheduled. - "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. [Output Only] The duration for graceful shutdown. Only applicable when - # the instance is in `PENDING_STOP` state. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -12009,8 +12012,9 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "requestTimestamp": "A String", # Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP` - # state of instance in RFC3339 text format. + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. }, "sizeInUnit": 3.14, # Output only. [Output only] The size of the VM represented by this Managed Instance. # This is how much this Managed Instance contributes to the diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index f2c7c86668..268cb6eab2 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -791,6 +791,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -888,6 +890,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -899,6 +910,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1317,6 +1337,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only @@ -2331,6 +2352,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2428,6 +2451,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2439,6 +2471,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2857,6 +2898,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only @@ -3856,6 +3898,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3953,6 +3997,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3964,6 +4017,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4382,6 +4444,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only @@ -5391,6 +5454,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5488,6 +5553,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5499,6 +5573,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5917,6 +6000,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index b97de9b9b7..0e2a43db60 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -677,6 +677,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -688,6 +697,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2180,6 +2198,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -2303,6 +2323,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2314,6 +2343,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2631,6 +2669,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs @@ -3023,6 +3063,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, "zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides. # You must specify this field as part of the HTTP request URL. It is @@ -4928,6 +4969,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5025,6 +5068,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5036,6 +5088,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5454,6 +5515,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in @@ -7661,6 +7723,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -7784,6 +7848,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -7795,6 +7868,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -8112,6 +8194,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs @@ -8504,6 +8588,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, "zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides. # You must specify this field as part of the HTTP request URL. It is @@ -8539,7 +8624,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -8672,11 +8759,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -8730,7 +8818,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -8863,11 +8953,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -10853,6 +10944,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -10976,6 +11069,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -10987,6 +11089,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -11304,6 +11415,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs @@ -11696,6 +11809,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, "zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides. # You must specify this field as part of the HTTP request URL. It is @@ -12737,6 +12851,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -12860,6 +12976,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -12871,6 +12996,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -13188,6 +13322,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs @@ -13580,6 +13716,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, "zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides. # You must specify this field as part of the HTTP request URL. It is @@ -23559,6 +23696,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -23682,6 +23821,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -23693,6 +23841,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -24010,6 +24167,8 @@

Method Details

"availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value # must be a number between 1 and the number of availability domains # specified in the spread placement policy attached to the instance. + "gracefulShutdownTimestamp": "A String", # Output only. Specifies the timestamp, when the instance will start graceful shutdown + # process, in RFC3339 text format. "terminationTimestamp": "A String", # Time in future when the instance will be terminated inRFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs @@ -24402,6 +24561,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, "zone": "A String", # Output only. [Output Only] URL of the zone where the instance resides. # You must specify this field as part of the HTTP request URL. It is @@ -25443,6 +25603,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -25454,6 +25623,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 9de998479a..f6c0422113 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -969,6 +969,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -1066,6 +1068,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1077,6 +1088,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1495,6 +1515,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image. @@ -1933,6 +1954,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1944,6 +1974,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3227,6 +3266,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3324,6 +3365,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3335,6 +3385,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3753,6 +3812,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image. @@ -4191,6 +4251,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4202,6 +4271,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5491,6 +5569,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5588,6 +5668,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5599,6 +5688,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -6017,6 +6115,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "kind": "compute#machineImage", # Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image. @@ -6455,6 +6554,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -6466,6 +6574,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html index f17ebc7215..f4ecf53c5f 100644 --- a/docs/dyn/compute_alpha.networkAttachments.html +++ b/docs/dyn/compute_alpha.networkAttachments.html @@ -272,12 +272,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -732,12 +734,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1180,12 +1184,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1635,12 +1641,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1765,12 +1773,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html index e98dd6948c..59cbaf5f33 100644 --- a/docs/dyn/compute_alpha.networkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html @@ -481,7 +481,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -614,11 +616,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -967,7 +970,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1100,11 +1105,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1607,7 +1613,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1740,11 +1748,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1858,7 +1867,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1991,11 +2002,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2805,7 +2817,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2938,11 +2952,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3056,7 +3071,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3189,11 +3206,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3684,7 +3702,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3817,11 +3837,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3887,7 +3908,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4020,11 +4043,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4132,7 +4156,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4265,11 +4291,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4383,7 +4410,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4516,11 +4545,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5028,7 +5058,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5161,11 +5193,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5279,7 +5312,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5412,11 +5447,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5596,7 +5632,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5729,11 +5767,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5847,7 +5886,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5980,11 +6021,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6665,7 +6707,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6798,11 +6842,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -7148,7 +7193,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -7281,11 +7328,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index fdcd6676dd..dc64ce096f 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -1358,7 +1358,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1491,11 +1493,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1547,7 +1550,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1680,11 +1685,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 9a1147cc79..68dbff8243 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -97,7 +97,7 @@

Instance Methods

Retrieves the list of regional BackendService resources available to the

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project in

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -6581,8 +6581,10 @@

Method Details

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project in
-the given region.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project in the
+given region. Backend services for external and internal passthrough
+Network Load Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
index b1e9ccd98a..162346d217 100644
--- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
+++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html
@@ -8695,6 +8695,9 @@ 

Method Details

# Policy. # - TERMINATION_TIMESTAMP Instance reached termination time, # thus managed instance group stops/deletes it. + # - GRACEFUL_SHUTDOWN_TIMESTAMP Instance reached graceful + # shutdown time, thus managed instance group stops/deletes it to + # gracefully shut it down. }, "id": "A String", # Output only. [Output only] The unique identifier for this resource. This field is empty # when instance does not exist. @@ -9864,17 +9867,17 @@

Method Details

# e.g. 'Intel Ice Lake'. "provisioningModel": "A String", # Output only. The provisioning model to be used for this instance. }, - "scheduling": { # Output only. [Output Only] Information about the termination timestamp of the instance, - # if applicable. - "gracefulShutdownTimestamp": "A String", # Output only. [Output Only] The timestamp at which the underlying instance will be + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. - "terminationTimestamp": "A String", # Output only. [Output Only] The timestamp at which the managed instance will be - # terminated. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. }, - "shutdownDetails": { # Output only. [Output Only] Specifies the graceful shutdown details if the instance is in + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in # `PENDING_STOP` state or there is a programmed stop scheduled. - "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. [Output Only] The duration for graceful shutdown. Only applicable when - # the instance is in `PENDING_STOP` state. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9886,8 +9889,9 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "requestTimestamp": "A String", # Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP` - # state of instance in RFC3339 text format. + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. }, "sizeInUnit": 3.14, # Output only. [Output only] The size of the VM represented by this Managed Instance. # This is how much this Managed Instance contributes to the diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 73bcfc9623..912ed35472 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -981,6 +981,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -1078,6 +1080,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1089,6 +1100,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1507,6 +1527,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only @@ -2136,6 +2157,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2233,6 +2256,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2244,6 +2276,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -2662,6 +2703,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only @@ -3672,6 +3714,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3769,6 +3813,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3780,6 +3833,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4198,6 +4260,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "region": "A String", # Output only. [Output Only] URL of the region where the instance template resides. Only diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 0487dc9596..291e012664 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -1131,6 +1131,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -1228,6 +1230,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1239,6 +1250,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1657,6 +1677,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index 365ce453a8..dc139b87f5 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -468,7 +468,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -601,11 +603,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1602,7 +1605,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1735,11 +1740,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1853,7 +1859,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1986,11 +1994,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2123,7 +2132,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2256,11 +2267,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2312,7 +2324,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2445,11 +2459,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3062,7 +3077,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3195,11 +3212,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3307,7 +3325,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3440,11 +3460,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3558,7 +3579,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3691,11 +3714,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4205,7 +4229,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4338,11 +4364,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4456,7 +4483,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4589,11 +4618,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4774,7 +4804,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4907,11 +4939,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5025,7 +5058,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5158,11 +5193,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5845,7 +5881,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5978,11 +6016,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_alpha.reliabilityRisks.html b/docs/dyn/compute_alpha.reliabilityRisks.html index f3ca82122f..0f6e8fff3f 100644 --- a/docs/dyn/compute_alpha.reliabilityRisks.html +++ b/docs/dyn/compute_alpha.reliabilityRisks.html @@ -108,17 +108,17 @@

Method Details

An object of the form: { # Represents a ReliabilityRisk resource. - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 # text format. "description": "A String", # An optional textual description of the resource; provided when the # resource is created. - "details": { # Details about a risk. # [Output Only] Details of the reliability risk resource + "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource "duration": "A String", # The duration of the risk since it was detected. - "globalDnsInsight": { - "projectDefaultIsGlobalDns": True or False, # Whether the project default DNS setting is global or not. + "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk. + "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS. "queryObservationWindow": "A String", # The observation window for the query counts. - "riskyQueryCount": "A String", # The number of queries that are risky. This will always be less than - # total_query_count. + "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or + # equal to total_query_count. "totalQueryCount": "A String", # The total number of queries in the observation window. }, "lastUpdateTimestamp": "A String", # The last time the risk was updated. @@ -130,8 +130,8 @@

Method Details

"kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk # for reliability risks. "name": "A String", # Name of the resource. The name must be 1-63 characters long and - # comply withRFC1035. - "recommendation": { # Recommendation with reference url. # The recommendations to mitigate the risk. + # comply with RFC1035. + "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk. "content": "A String", # Mitigation guide for the risk. "referenceUrl": "A String", # URL referencing a more detailed mitigation guide. }, @@ -237,22 +237,22 @@

Method Details

Returns: An object of the form: - { + { # Response message for the List method of ReliabilityRisksService. "etag": "A String", "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. "items": [ # A list of ReliabilityRisk resources. { # Represents a ReliabilityRisk resource. - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339 # text format. "description": "A String", # An optional textual description of the resource; provided when the # resource is created. - "details": { # Details about a risk. # [Output Only] Details of the reliability risk resource + "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource "duration": "A String", # The duration of the risk since it was detected. - "globalDnsInsight": { - "projectDefaultIsGlobalDns": True or False, # Whether the project default DNS setting is global or not. + "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk. + "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS. "queryObservationWindow": "A String", # The observation window for the query counts. - "riskyQueryCount": "A String", # The number of queries that are risky. This will always be less than - # total_query_count. + "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or + # equal to total_query_count. "totalQueryCount": "A String", # The total number of queries in the observation window. }, "lastUpdateTimestamp": "A String", # The last time the risk was updated. @@ -264,8 +264,8 @@

Method Details

"kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk # for reliability risks. "name": "A String", # Name of the resource. The name must be 1-63 characters long and - # comply withRFC1035. - "recommendation": { # Recommendation with reference url. # The recommendations to mitigate the risk. + # comply with RFC1035. + "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk. "content": "A String", # Mitigation guide for the risk. "referenceUrl": "A String", # URL referencing a more detailed mitigation guide. }, diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index f95b348ed3..0c72ba7a0e 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -3487,6 +3487,7 @@

Method Details

"uptimeMs": "A String", # Session uptime in milliseconds. Value will be 0 if session is not up. "usingEchoMode": True or False, # Indicates if echo mode is currently being used. }, + "depreferenced": True or False, # Output only. [Output Only] Indicates whether the BGP peer is in a depreferenced state. "enableIpv4": True or False, # Output only. Enable IPv4 traffic over BGP Peer. # It is enabled by default if the peerIpAddress is version 4. "enableIpv6": True or False, # Output only. Enable IPv6 traffic over BGP Peer. diff --git a/docs/dyn/compute_alpha.targetHttpsProxies.html b/docs/dyn/compute_alpha.targetHttpsProxies.html index 36565129ee..b51a69a366 100644 --- a/docs/dyn/compute_alpha.targetHttpsProxies.html +++ b/docs/dyn/compute_alpha.targetHttpsProxies.html @@ -3201,8 +3201,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.targetSslProxies.html b/docs/dyn/compute_alpha.targetSslProxies.html index b9d28bb833..fc59885b4e 100644 --- a/docs/dyn/compute_alpha.targetSslProxies.html +++ b/docs/dyn/compute_alpha.targetSslProxies.html @@ -2225,8 +2225,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index 0773c9af1c..2a0f626cf3 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -1259,6 +1259,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -1356,6 +1358,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1367,6 +1378,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -1785,6 +1805,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in @@ -3767,6 +3788,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3864,6 +3887,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -3875,6 +3907,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -4293,6 +4334,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in @@ -5591,6 +5633,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5688,6 +5732,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -5699,6 +5752,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -6117,6 +6179,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in @@ -7791,6 +7854,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -7888,6 +7953,15 @@

Method Details

"aliasIpRanges": [ # An array of alias IP ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -7899,6 +7973,15 @@

Method Details

"aliasIpv6Ranges": [ # An array of alias IPv6 ranges for this network interface. # You can only specify this field for network interfaces in VPC networks. { # An alias IP range attached to an instance's network interface. + "candidateSubnetworkRangeNames": [ # Identifies the candidate subnetwork range names for the alias + # IPs to be allocated from. When it is set, the IP would be allocated from + # any subnetwork range defined here if the IPs are available. + # Only one of subnetwork_range_name or candidate_subnetwork_range_names + # should be set. + "A String", + ], + "effectiveSubnetworkRangeName": "A String", # Output only. [Output Only] The subnetwork range name where the IP is allocated. + # It will be set to the subnetwork range where the IP is allocated only. "ipCidrRange": "A String", # The IP alias ranges to allocate for this interface. This IP CIDR range # must belong to the specified subnetwork and cannot contain IP addresses # reserved by system or used by other network interfaces. This range may be @@ -8317,6 +8400,7 @@

Method Details

"workloadIdentityConfig": { "identity": "A String", "identityCertificateEnabled": True or False, + "identityType": "A String", }, }, "locationPolicy": { # Configuration for location policy among multiple possible locations # Policy for choosing target zone. For more information, seeCreate VMs in diff --git a/docs/dyn/compute_beta.addresses.html b/docs/dyn/compute_beta.addresses.html index 02c63043dc..f6afae3c2c 100644 --- a/docs/dyn/compute_beta.addresses.html +++ b/docs/dyn/compute_beta.addresses.html @@ -241,21 +241,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -748,21 +761,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -872,21 +898,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1371,21 +1410,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_beta.advice.html b/docs/dyn/compute_beta.advice.html index b797cc94ed..cd6740dc40 100644 --- a/docs/dyn/compute_beta.advice.html +++ b/docs/dyn/compute_beta.advice.html @@ -360,11 +360,12 @@

Method Details

An object of the form: { # Contains the capacity history. - "location": "A String", - "machineType": "A String", - "preemptionHistory": [ - { - "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + "location": "A String", # Output only. The location (region or zone) for which the capacity history is returned. + # It is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone. + "machineType": "A String", # The machine type for which the capacity history is returned. + "preemptionHistory": [ # The preemption history for the requested machine type and location. + { # A record of Spot VM preemption history. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this preemption record. # Timestamp end (exclusive). # # The start must be less than or equal to the end. @@ -379,12 +380,15 @@

Method Details

# If specified, a Timestamp matching this interval will have to be the same # or after the start. }, - "preemptionRate": 3.14, + "preemptionRate": 3.14, # The preemption rate during the interval, representing the fraction of + # Spot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is + # calculated as (total preempted Spots) / (total Spots that stopped + # running). }, ], - "priceHistory": [ - { - "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a + "priceHistory": [ # The price history for the requested machine type and location. + { # A record of price history. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a # The time interval for this price record. # Timestamp end (exclusive). # # The start must be less than or equal to the end. @@ -399,7 +403,7 @@

Method Details

# If specified, a Timestamp matching this interval will have to be the same # or after the start. }, - "listPrice": { # Represents an amount of money with its currency type. + "listPrice": { # Represents an amount of money with its currency type. # The Spot VM list price during the interval. "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. # The value must be between -999,999,999 and +999,999,999 inclusive. diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index ae5d6bf6e1..e2839c9565 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -112,7 +112,7 @@

Instance Methods

Retrieves the list of BackendService resources available to the specified

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project.

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -8270,7 +8270,10 @@

Method Details

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project.
+Backend services for external and internal passthrough Network Load
+Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html
index 19c3c379ae..3a71f73b93 100644
--- a/docs/dyn/compute_beta.firewallPolicies.html
+++ b/docs/dyn/compute_beta.firewallPolicies.html
@@ -472,7 +472,9 @@ 

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -605,11 +607,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -952,7 +955,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1085,11 +1090,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2073,7 +2079,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2206,11 +2214,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2285,7 +2294,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2418,11 +2429,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2899,7 +2911,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3032,11 +3046,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3101,7 +3116,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3234,11 +3251,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3345,7 +3363,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3478,11 +3498,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3557,7 +3578,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3690,11 +3713,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4196,7 +4220,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4329,11 +4355,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4408,7 +4435,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4541,11 +4570,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5047,7 +5077,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5180,11 +5212,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5259,7 +5292,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5392,11 +5427,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5753,7 +5789,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5886,11 +5924,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6234,7 +6273,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6367,11 +6408,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_beta.globalAddresses.html b/docs/dyn/compute_beta.globalAddresses.html index 6ded6daf7f..f6c5747b4d 100644 --- a/docs/dyn/compute_beta.globalAddresses.html +++ b/docs/dyn/compute_beta.globalAddresses.html @@ -433,21 +433,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -556,21 +569,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1053,21 +1079,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_beta.html b/docs/dyn/compute_beta.html index caaa77cb50..95272bac6d 100644 --- a/docs/dyn/compute_beta.html +++ b/docs/dyn/compute_beta.html @@ -584,6 +584,11 @@

Instance Methods

Returns the regions Resource.

+

+ reliabilityRisks() +

+

Returns the reliabilityRisks Resource.

+

reservationBlocks()

diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 338abf2873..b507fd031d 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -9221,17 +9221,17 @@

Method Details

# e.g. 'Intel Ice Lake'. "provisioningModel": "A String", # Output only. The provisioning model to be used for this instance. }, - "scheduling": { # Output only. [Output Only] Information about the termination timestamp of the instance, - # if applicable. - "gracefulShutdownTimestamp": "A String", # Output only. [Output Only] The timestamp at which the underlying instance will be + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. - "terminationTimestamp": "A String", # Output only. [Output Only] The timestamp at which the managed instance will be - # terminated. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. }, - "shutdownDetails": { # Output only. [Output Only] Specifies the graceful shutdown details if the instance is in + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in # `PENDING_STOP` state or there is a programmed stop scheduled. - "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. [Output Only] The duration for graceful shutdown. Only applicable when - # the instance is in `PENDING_STOP` state. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -9243,8 +9243,9 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "requestTimestamp": "A String", # Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP` - # state of instance in RFC3339 text format. + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. }, "targetStatus": "A String", # Output only. [Output Only] The eventual status of the instance. The instance group # manager will not be identified as stable till each managed instance reaches diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index e5659aecb3..fc6fd60b71 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -777,6 +777,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2219,6 +2221,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3647,6 +3651,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5084,6 +5090,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 26f49ee56f..620c4145e1 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -2119,6 +2119,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -4646,6 +4648,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -7273,6 +7277,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -7959,7 +7965,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -8092,11 +8100,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -8150,7 +8159,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -8283,11 +8294,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -10194,6 +10206,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -11871,6 +11885,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -22196,6 +22212,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index 59aaa7b090..8352e66c2c 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -954,6 +954,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3049,6 +3051,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -5149,6 +5153,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_beta.networkAttachments.html b/docs/dyn/compute_beta.networkAttachments.html index bc4f68e4f6..08fd18b9d7 100644 --- a/docs/dyn/compute_beta.networkAttachments.html +++ b/docs/dyn/compute_beta.networkAttachments.html @@ -272,12 +272,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -731,12 +733,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1179,12 +1183,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1633,12 +1639,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1763,12 +1771,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index 28de2ebeb5..fe220e3aee 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -474,7 +474,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -607,11 +609,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -959,7 +962,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1092,11 +1097,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1598,7 +1604,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1731,11 +1739,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1810,7 +1819,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1943,11 +1954,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2744,7 +2756,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2877,11 +2891,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2956,7 +2971,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3089,11 +3106,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3573,7 +3591,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3706,11 +3726,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3776,7 +3797,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3909,11 +3932,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4021,7 +4045,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4154,11 +4180,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4233,7 +4260,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4366,11 +4395,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4866,7 +4896,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4999,11 +5031,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5078,7 +5111,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5211,11 +5246,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5384,7 +5420,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5517,11 +5555,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5596,7 +5635,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5729,11 +5770,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6091,7 +6133,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6224,11 +6268,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6573,7 +6618,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6706,11 +6753,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_beta.networks.html b/docs/dyn/compute_beta.networks.html index 54c6c126d2..0438648db1 100644 --- a/docs/dyn/compute_beta.networks.html +++ b/docs/dyn/compute_beta.networks.html @@ -1331,7 +1331,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1464,11 +1466,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1520,7 +1523,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1653,11 +1658,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html index ce5530bd09..2ddcb58660 100644 --- a/docs/dyn/compute_beta.regionBackendServices.html +++ b/docs/dyn/compute_beta.regionBackendServices.html @@ -97,7 +97,7 @@

Instance Methods

Retrieves the list of regional BackendService resources available to the

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project in

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -5364,8 +5364,10 @@

Method Details

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project in
-the given region.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project in the
+given region. Backend services for external and internal passthrough
+Network Load Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.regionCommitments.html b/docs/dyn/compute_beta.regionCommitments.html
index 5f2a4aee49..1e7b8c1f22 100644
--- a/docs/dyn/compute_beta.regionCommitments.html
+++ b/docs/dyn/compute_beta.regionCommitments.html
@@ -285,6 +285,16 @@ 

Method Details

"a_key": "A String", }, }, + "persistentDiskResources": [ # Optional. Used when category is PERSISTENT_DISK. + # Each entry in the list represents a commitment to a specific Persistent + # Disk product type and dimension. + { # Commitment for a particular persistent disk resource. + "amount": "A String", # Required. The amount of the resource to commit to, in GiB. + "dimensionType": "A String", # The specific dimension of the product for this amount. + "productType": "A String", # The PD product being committed to. All entries in a + # Commitment.persistent_disk_resources list must have the same product_type. + }, + ], "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -781,6 +791,16 @@

Method Details

"a_key": "A String", }, }, + "persistentDiskResources": [ # Optional. Used when category is PERSISTENT_DISK. + # Each entry in the list represents a commitment to a specific Persistent + # Disk product type and dimension. + { # Commitment for a particular persistent disk resource. + "amount": "A String", # Required. The amount of the resource to commit to, in GiB. + "dimensionType": "A String", # The specific dimension of the product for this amount. + "productType": "A String", # The PD product being committed to. All entries in a + # Commitment.persistent_disk_resources list must have the same product_type. + }, + ], "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -1187,6 +1207,16 @@

Method Details

"a_key": "A String", }, }, + "persistentDiskResources": [ # Optional. Used when category is PERSISTENT_DISK. + # Each entry in the list represents a commitment to a specific Persistent + # Disk product type and dimension. + { # Commitment for a particular persistent disk resource. + "amount": "A String", # Required. The amount of the resource to commit to, in GiB. + "dimensionType": "A String", # The specific dimension of the product for this amount. + "productType": "A String", # The PD product being committed to. All entries in a + # Commitment.persistent_disk_resources list must have the same product_type. + }, + ], "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -1968,6 +1998,16 @@

Method Details

"a_key": "A String", }, }, + "persistentDiskResources": [ # Optional. Used when category is PERSISTENT_DISK. + # Each entry in the list represents a commitment to a specific Persistent + # Disk product type and dimension. + { # Commitment for a particular persistent disk resource. + "amount": "A String", # Required. The amount of the resource to commit to, in GiB. + "dimensionType": "A String", # The specific dimension of the product for this amount. + "productType": "A String", # The PD product being committed to. All entries in a + # Commitment.persistent_disk_resources list must have the same product_type. + }, + ], "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that @@ -2459,6 +2499,16 @@

Method Details

"a_key": "A String", }, }, + "persistentDiskResources": [ # Optional. Used when category is PERSISTENT_DISK. + # Each entry in the list represents a commitment to a specific Persistent + # Disk product type and dimension. + { # Commitment for a particular persistent disk resource. + "amount": "A String", # Required. The amount of the resource to commit to, in GiB. + "dimensionType": "A String", # The specific dimension of the product for this amount. + "productType": "A String", # The PD product being committed to. All entries in a + # Commitment.persistent_disk_resources list must have the same product_type. + }, + ], "plan": "A String", # The minimum time duration that you commit to purchasing resources. # The plan that you choose determines the preset term length of the # commitment (which is 1 year or 3 years) and affects the discount rate that diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index b7753b7fec..e9fe4a1172 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -7662,17 +7662,17 @@

Method Details

# e.g. 'Intel Ice Lake'. "provisioningModel": "A String", # Output only. The provisioning model to be used for this instance. }, - "scheduling": { # Output only. [Output Only] Information about the termination timestamp of the instance, - # if applicable. - "gracefulShutdownTimestamp": "A String", # Output only. [Output Only] The timestamp at which the underlying instance will be + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. - "terminationTimestamp": "A String", # Output only. [Output Only] The timestamp at which the managed instance will be - # terminated. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. }, - "shutdownDetails": { # Output only. [Output Only] Specifies the graceful shutdown details if the instance is in + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in # `PENDING_STOP` state or there is a programmed stop scheduled. - "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. [Output Only] The duration for graceful shutdown. Only applicable when - # the instance is in `PENDING_STOP` state. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. # as a count of seconds and fractions of seconds at nanosecond # resolution. It is independent of any calendar and concepts like "day" # or "month". Range is approximately 10,000 years. @@ -7684,8 +7684,9 @@

Method Details

# to 315,576,000,000 inclusive. Note: these bounds are computed from: # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years }, - "requestTimestamp": "A String", # Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP` - # state of instance in RFC3339 text format. + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. }, "targetStatus": "A String", # Output only. [Output Only] The eventual status of the instance. The instance group # manager will not be identified as stable till each managed instance reaches diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index a184b4afff..1254e654af 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -966,6 +966,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2024,6 +2026,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3462,6 +3466,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 768dcfee09..cb0889e469 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -1109,6 +1109,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index 155b7da22b..d396f5200e 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -467,7 +467,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -600,11 +602,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1598,7 +1601,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1731,11 +1736,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1810,7 +1816,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1943,11 +1951,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2069,7 +2078,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2202,11 +2213,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2258,7 +2270,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2391,11 +2405,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3007,7 +3022,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3140,11 +3157,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3252,7 +3270,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3385,11 +3405,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3464,7 +3485,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3597,11 +3620,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4099,7 +4123,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4232,11 +4258,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4311,7 +4338,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4444,11 +4473,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4618,7 +4648,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4751,11 +4783,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4830,7 +4863,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4963,11 +4998,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5637,7 +5673,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5770,11 +5808,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_beta.regionUrlMaps.html b/docs/dyn/compute_beta.regionUrlMaps.html index 55a1235fd2..228b963169 100644 --- a/docs/dyn/compute_beta.regionUrlMaps.html +++ b/docs/dyn/compute_beta.regionUrlMaps.html @@ -1049,6 +1049,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -1906,6 +1934,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -2744,6 +2800,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -3844,6 +3928,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -4701,6 +4813,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -5558,6 +5698,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -6396,6 +6564,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -7496,6 +7692,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -9026,6 +9250,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -9883,6 +10135,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -10721,6 +11001,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -11821,6 +12129,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -12729,6 +13065,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -13586,6 +13950,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -14424,6 +14816,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -15524,6 +15944,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -16689,6 +17137,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -17546,6 +18022,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -18384,6 +18888,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -19484,6 +20016,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -20617,6 +21177,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -21474,6 +22062,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -22312,6 +22928,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -23412,6 +24056,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to diff --git a/docs/dyn/compute_beta.reliabilityRisks.html b/docs/dyn/compute_beta.reliabilityRisks.html new file mode 100644 index 0000000000..df068a2b9e --- /dev/null +++ b/docs/dyn/compute_beta.reliabilityRisks.html @@ -0,0 +1,328 @@ + + + +

Compute Engine API . reliabilityRisks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, reliabilityRisk, x__xgafv=None)

+

Returns the specified ReliabilityRisk resource.

+

+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves the list of reliabilityRisks available in the specified project.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, reliabilityRisk, x__xgafv=None) +
Returns the specified ReliabilityRisk resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  reliabilityRisk: string, Name of the ReliabilityRisk resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a ReliabilityRisk resource.
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
+      # text format.
+  "description": "A String", # An optional textual description of the resource; provided when the
+      # resource is created.
+  "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource
+    "duration": "A String", # The duration of the risk since it was detected.
+    "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk.
+      "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS.
+      "queryObservationWindow": "A String", # The observation window for the query counts.
+      "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or
+          # equal to total_query_count.
+      "totalQueryCount": "A String", # The total number of queries in the observation window.
+    },
+    "lastUpdateTimestamp": "A String", # The last time the risk was updated.
+    "severity": "A String", # The severity of the risk.
+    "type": "A String", # The type of risk.
+  },
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
+      # for reliability risks.
+  "name": "A String", # Name of the resource. The name must be 1-63 characters long and
+      # comply with RFC1035.
+  "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk.
+    "content": "A String", # Mitigation guide for the risk.
+    "referenceUrl": "A String", # URL referencing a more detailed mitigation guide.
+  },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+}
+
+ +
+ list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
Retrieves the list of reliabilityRisks available in the specified project.
+
+Args:
+  project: string, Project ID for this request. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  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 the List method of ReliabilityRisksService.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of ReliabilityRisk resources.
+    { # Represents a ReliabilityRisk resource.
+      "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp in RFC3339
+          # text format.
+      "description": "A String", # An optional textual description of the resource; provided when the
+          # resource is created.
+      "details": { # Detailed insights and metrics about a detected reliability risk. # [Output Only] Details of the reliability risk resource
+        "duration": "A String", # The duration of the risk since it was detected.
+        "globalDnsInsight": { # Detailed insights for a global DNS reliability risk. # Insight details for global DNS risk.
+          "projectDefaultIsGlobalDns": True or False, # Indicates whether the project's default DNS setting is global DNS.
+          "queryObservationWindow": "A String", # The observation window for the query counts.
+          "riskyQueryCount": "A String", # The number of queries that are risky. This is always less than or
+              # equal to total_query_count.
+          "totalQueryCount": "A String", # The total number of queries in the observation window.
+        },
+        "lastUpdateTimestamp": "A String", # The last time the risk was updated.
+        "severity": "A String", # The severity of the risk.
+        "type": "A String", # The type of risk.
+      },
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+          # defined by the server.
+      "kind": "compute#reliabilityRisk", # Output only. [Output Only] Type of resource. Always compute#reliabilityRisk
+          # for reliability risks.
+      "name": "A String", # Name of the resource. The name must be 1-63 characters long and
+          # comply with RFC1035.
+      "recommendation": { # Recommendation for mitigating a reliability risk, including a reference URL. # The recommendation to mitigate the risk.
+        "content": "A String", # Mitigation guide for the risk.
+        "referenceUrl": "A String", # URL referencing a more detailed mitigation guide.
+      },
+      "selfLink": "A String", # Output only. [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # Output only. [Output Only] Server-defined URL for this resource with the resource id.
+    },
+  ],
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+      # end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_beta.subnetworks.html b/docs/dyn/compute_beta.subnetworks.html index 4b663398bb..6f9c51437e 100644 --- a/docs/dyn/compute_beta.subnetworks.html +++ b/docs/dyn/compute_beta.subnetworks.html @@ -330,6 +330,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -1298,6 +1302,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -1941,6 +1949,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -2598,6 +2610,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. @@ -3150,6 +3166,10 @@

Method Details

# instances and Forwarding Rules. It can also be used to reserve IPv6 # addresses with both VM and FR endpoint types. Such a subnetwork gets its # IPv6 range from Google IP Pool directly. + "ipv6NetworkTier": "A String", # Specifies the network tier for EXTERNAL IPv6. Can only be set when + # ipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not + # specified during the creation of the subnetwork. This field is IMMUTABLE + # once set with EXTERNAL IPv6. "kind": "compute#subnetwork", # Output only. [Output Only] Type of the resource. Always compute#subnetwork # for Subnetwork resources. "logConfig": { # The available logging options for this subnetwork. # This field denotes the VPC flow logging options for this subnetwork. diff --git a/docs/dyn/compute_beta.targetHttpsProxies.html b/docs/dyn/compute_beta.targetHttpsProxies.html index aea0c9f905..46aae2d81f 100644 --- a/docs/dyn/compute_beta.targetHttpsProxies.html +++ b/docs/dyn/compute_beta.targetHttpsProxies.html @@ -3190,8 +3190,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_beta.targetSslProxies.html b/docs/dyn/compute_beta.targetSslProxies.html index efd870c2fe..8359fd6b50 100644 --- a/docs/dyn/compute_beta.targetSslProxies.html +++ b/docs/dyn/compute_beta.targetSslProxies.html @@ -2219,8 +2219,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_beta.urlMaps.html b/docs/dyn/compute_beta.urlMaps.html index c339db6d03..7cbb905377 100644 --- a/docs/dyn/compute_beta.urlMaps.html +++ b/docs/dyn/compute_beta.urlMaps.html @@ -867,6 +867,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -1724,6 +1752,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -2562,6 +2618,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -3662,6 +3746,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -4899,6 +5011,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -5756,6 +5896,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -6594,6 +6762,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -7694,6 +7890,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -8550,6 +8774,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -9407,6 +9659,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -10245,6 +10525,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -11345,6 +11653,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -12895,6 +13231,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -13752,6 +14116,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -14590,6 +14982,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -15690,6 +16110,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -16597,6 +17045,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -17454,6 +17930,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -18292,6 +18796,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -19392,6 +19924,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -20566,6 +21126,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -21423,6 +22011,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -22261,6 +22877,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -23361,6 +24005,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -24521,6 +25193,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -25378,6 +26078,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -26216,6 +26944,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to @@ -27316,6 +28072,34 @@

Method Details

# required. # # Only one of path_prefix_rewrite orpath_template_rewrite may be specified. + "regexRewrite": { # The spec for modifying the path using a regular expression. # The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified. + "pathPattern": "A String", # The regular expression used to match against the URL path. + # It uses RE2 syntax with the following constraints: + # + # + # - Any single character operators + # - Groups are allowed to have only submatch operator inside + # - Groups are allowed only without any char repetition, e.g. + # .* + # - Any char repetition, e.g. .*, is + # only allowed to be used in a single regex together with: + # + # + # - Empty string operators + # - Other repetitions + # - Ranges + # - Repetitions of ranges + # + # + # - Ranges are only allowed to have: + # + # + # - Character range + # - Digits range + # - Symbols listed in characters allowed for ranges + "pathSubstitution": "A String", # Required when path pattern is specified. Used to rewrite matching parts of + # the path. + }, }, "weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match # occurs. The weights determine the fraction of traffic that flows to diff --git a/docs/dyn/compute_v1.addresses.html b/docs/dyn/compute_v1.addresses.html index fdf43f3027..dee846b0f6 100644 --- a/docs/dyn/compute_v1.addresses.html +++ b/docs/dyn/compute_v1.addresses.html @@ -241,21 +241,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -748,21 +761,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -872,21 +898,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1371,21 +1410,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 1476359fc3..781a52f7a3 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -112,7 +112,7 @@

Instance Methods

Retrieves the list of BackendService resources available to the specified

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project.

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -7198,7 +7198,10 @@

Method Details

listUsable(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project.
+Backend services for external and internal passthrough Network Load
+Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.firewallPolicies.html b/docs/dyn/compute_v1.firewallPolicies.html
index a30e41d22e..afe6db5db6 100644
--- a/docs/dyn/compute_v1.firewallPolicies.html
+++ b/docs/dyn/compute_v1.firewallPolicies.html
@@ -454,7 +454,9 @@ 

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -585,11 +587,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1567,7 +1570,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1698,11 +1703,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1767,7 +1773,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1898,11 +1906,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2373,7 +2382,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2504,11 +2515,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2609,7 +2621,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2740,11 +2754,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2809,7 +2824,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2940,11 +2957,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3440,7 +3458,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3571,11 +3591,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3640,7 +3661,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3771,11 +3794,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4265,7 +4289,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4396,11 +4422,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4465,7 +4492,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4596,11 +4625,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4957,7 +4987,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5088,11 +5120,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_v1.globalAddresses.html b/docs/dyn/compute_v1.globalAddresses.html index ef5e550928..7d85d4aa7a 100644 --- a/docs/dyn/compute_v1.globalAddresses.html +++ b/docs/dyn/compute_v1.globalAddresses.html @@ -433,21 +433,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. # - - # Partial URL, as in + # Case 2: Internal Range for global internal addresses. # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # + # - + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # + # + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -556,21 +569,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # # # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # For an Internal Range: + # + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint @@ -1053,21 +1079,34 @@

Method Details

# create the resource. "id": "A String", # Output only. [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "ipCollection": "A String", # Reference to the source of external IPv4 addresses, - # like a PublicDelegatedPrefix (PDP) for BYOIP. - # The PDP must support enhanced IPv4 allocations. + "ipCollection": "A String", # Reference to the source of IP addresses. # - # Use one of the following formats to specify a PDP when reserving an - # external IPv4 address using BYOIP. + # It supports the following cases: # # - - # Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4 + # addresses. The PDP must support enhanced IPv4 allocations. + # - + # Case 2: Internal Range for global internal addresses. + # + # + # + # Use one of the following formats to specify the resource: + # + # For a Public Delegated Prefix: + # # - - # Partial URL, as in + # Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp + # - Partial URL: + # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name + # - regions/region/publicDelegatedPrefixes/pdp-name + # + # # + # For an Internal Range: # - # - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - # - regions/region/publicDelegatedPrefixes/pdp-name + # - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range + # - Partial URL:projects/project/locations/global/internalRanges/internal-range "ipVersion": "A String", # The IP version that will be used by this address. Valid options areIPV4 or IPV6. "ipv6EndpointType": "A String", # The endpoint type of this address, which should be VM # or NETLB. This is used for deciding which type of endpoint diff --git a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html index 2c3241e4d2..24827c9a7b 100644 --- a/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_v1.instanceGroupManagerResizeRequests.html @@ -730,6 +730,77 @@

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. @@ -995,6 +1066,77 @@

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. @@ -1632,6 +1774,77 @@

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index 0be987fdc7..d29db7d201 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -93,10 +93,10 @@

Instance Methods

createInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Creates instances with per-instance configurations in this managed instance

- delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None)

+ delete(project, zone, instanceGroupManager, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Deletes the specified managed instance group and all of the instances

- deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ deleteInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group for immediate

deletePerInstanceConfigs(project, zone, instanceGroupManager, body=None, x__xgafv=None)

@@ -138,7 +138,7 @@

Instance Methods

patchPerInstanceConfigs(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Inserts or patches per-instance configurations for the managed instance

- recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ recreateInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified VM instances in the managed instance group to be

resize(project, zone, instanceGroupManager, size, requestId=None, x__xgafv=None)

@@ -156,7 +156,7 @@

Instance Methods

startInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group to be

- stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ stopInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group to be

suspendInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

@@ -2125,7 +2125,7 @@

Method Details

- delete(project, zone, instanceGroupManager, requestId=None, x__xgafv=None) + delete(project, zone, instanceGroupManager, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Deletes the specified managed instance group and all of the instances
 in that group. Note that the instance group must not belong to a
 backend service. Read
@@ -2136,6 +2136,8 @@ 

Method Details

zone: string, The name of thezone where the managed instance group is located. (required) instanceGroupManager: string, The name of the managed instance group to delete. (required) + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance deletion even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -2422,7 +2424,7 @@

Method Details

- deleteInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + deleteInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified instances in the managed instance group for immediate
 deletion. The instances are also removed from any target
 pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of
@@ -2463,6 +2465,8 @@ 

Method Details

# group's zone or region. } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance deletion even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -6242,6 +6246,32 @@

Method Details

# InstanceFlexibilityPolicy. "machineType": "A String", # Output only. The machine type to be used for this instance. }, + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be + # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. + }, + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in + # `PENDING_STOP` state or there is a programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. + }, "version": { # Output only. [Output Only] Intended version of this instance. "instanceTemplate": "A String", # Output only. [Output Only] The intended template of the instance. This field is empty # when current_action is one of { DELETING, ABANDONING }. @@ -7929,7 +7959,7 @@

Method Details

- recreateInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + recreateInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified VM instances in the managed instance group to be
 immediately recreated. Each instance is recreated using the group's current
 configuration. This operation is marked as DONE when the flag
@@ -7959,6 +7989,8 @@ 

Method Details

], } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance recreation even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -9825,7 +9857,7 @@

Method Details

- stopInstances(project, zone, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + stopInstances(project, zone, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified instances in the managed instance group to be
 immediately stopped. You can only specify instances that are running in
 this request. This method reduces thetargetSize and increases the targetStoppedSize
@@ -9869,6 +9901,8 @@ 

Method Details

], } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance stopping even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index a0d5e92398..60b1a72ad8 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -721,6 +721,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2049,6 +2051,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3368,6 +3372,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -4691,6 +4697,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index c4d737b6d7..38b2a39651 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -2051,6 +2051,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -4341,6 +4343,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -6857,6 +6861,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -7462,7 +7468,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -7593,11 +7601,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -7651,7 +7660,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -7782,11 +7793,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -9097,6 +9109,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -10636,6 +10650,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial @@ -20038,6 +20054,8 @@

Method Details

"lastStartTimestamp": "A String", # Output only. [Output Only] Last start timestamp inRFC3339 text format. "lastStopTimestamp": "A String", # Output only. [Output Only] Last stop timestamp inRFC3339 text format. "lastSuspendedTimestamp": "A String", # Output only. [Output Only] Last suspended timestamp inRFC3339 text format. + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # Full or partial URL of the machine type resource to use for this instance, # in the format:zones/zone/machineTypes/machine-type. This is provided by the client # when the instance is created. For example, the following is a valid partial diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index d60f765911..b68e77f648 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -898,6 +898,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -2839,6 +2841,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -4785,6 +4789,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_v1.networkAttachments.html b/docs/dyn/compute_v1.networkAttachments.html index 078979f89f..44426d1f09 100644 --- a/docs/dyn/compute_v1.networkAttachments.html +++ b/docs/dyn/compute_v1.networkAttachments.html @@ -272,12 +272,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -731,12 +733,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1179,12 +1183,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1633,12 +1639,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. @@ -1763,12 +1771,14 @@

Method Details

# subnetwork associated. Because it is required that all the subnetworks must # be from the same network, it is assured that the Network Attachment belongs # to the same network as all the subnetworks. - "producerAcceptLists": [ # Projects that are allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerAcceptLists": [ # Projects or service class ids that are allowed to connect to this network + # attachment. The project can be specified using its id or number. Service + # class id can be specified as "serviceclasses/{service_class_id}". "A String", ], - "producerRejectLists": [ # Projects that are not allowed to connect to this network attachment. - # The project can be specified using its id or number. + "producerRejectLists": [ # Projects or service class ids that are not allowed to connect to this + # network attachment. The project can be specified using its id or number. + # Service class id can be specified as "serviceclasses/{service_class_id}". "A String", ], "region": "A String", # Output only. [Output Only] URL of the region where the network attachment resides. diff --git a/docs/dyn/compute_v1.networkFirewallPolicies.html b/docs/dyn/compute_v1.networkFirewallPolicies.html index 7c7e5d7161..8450cd66c7 100644 --- a/docs/dyn/compute_v1.networkFirewallPolicies.html +++ b/docs/dyn/compute_v1.networkFirewallPolicies.html @@ -468,7 +468,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -599,11 +601,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -951,7 +954,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1082,11 +1087,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1582,7 +1588,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1713,11 +1721,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1782,7 +1791,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1913,11 +1924,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2708,7 +2720,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2839,11 +2853,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2908,7 +2923,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3039,11 +3056,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3517,7 +3535,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3648,11 +3668,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3718,7 +3739,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3849,11 +3872,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3955,7 +3979,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4086,11 +4112,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4155,7 +4182,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4286,11 +4315,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4780,7 +4810,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4911,11 +4943,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4980,7 +5013,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5111,11 +5146,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5278,7 +5314,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5409,11 +5447,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5478,7 +5517,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5609,11 +5650,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5971,7 +6013,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6102,11 +6146,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -6451,7 +6496,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -6582,11 +6629,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_v1.networks.html b/docs/dyn/compute_v1.networks.html index a0d312911d..f63dab9b61 100644 --- a/docs/dyn/compute_v1.networks.html +++ b/docs/dyn/compute_v1.networks.html @@ -1328,7 +1328,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1459,11 +1461,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1515,7 +1518,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1646,11 +1651,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index 3d15a3297b..7a911be618 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -97,7 +97,7 @@

Instance Methods

Retrieves the list of regional BackendService resources available to the

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

Retrieves a list of all usable backend services in the specified project in

+

Retrieves a list of all usable backend services for Application Load

listUsable_next()

Retrieves the next page of results.

@@ -5100,8 +5100,10 @@

Method Details

listUsable(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of all usable backend services in the specified project in
-the given region.
+  
Retrieves a list of all usable backend services for Application Load
+Balancers and Proxy Network Load Balancers in the specified project in the
+given region. Backend services for external and internal passthrough
+Network Load Balancers are not included in the response.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html
index 1be46373f7..494dd39d6c 100644
--- a/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html
+++ b/docs/dyn/compute_v1.regionInstanceGroupManagerResizeRequests.html
@@ -730,6 +730,77 @@ 

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. @@ -993,6 +1064,77 @@

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. @@ -1631,6 +1773,77 @@

Method Details

"description": "A String", # An optional description of this resource. "id": "A String", # Output only. A unique identifier for this resource type. The server generates this # identifier. + "instances": [ # The names of instances to be created by this resize request. The number of + # names specified determines the number of instances to create. The group's + # target size will be increased by this number. This field cannot be used + # together with 'resize_by'. + { + "fingerprint": "A String", # Fingerprint of this per-instance config. This field can be used in + # optimistic locking. It is ignored when inserting a per-instance + # config. An up-to-date fingerprint must be provided in order to update an + # existing per-instance configuration or the field needs to be unset. + "name": "A String", # The name of a per-instance configuration and its corresponding instance. + # Serves as a merge key during UpdatePerInstanceConfigs + # operations, that is, if a per-instance configuration with the same name + # exists then it will be updated, otherwise a new one will be created for the + # VM instance with the same name. An attempt to create a per-instance + # configuration for a VM instance that either doesn't exist or is not part + # of the group will result in an error. + "preservedState": { # Preserved state for a given instance. # The intended preserved state for the given instance. Does not contain + # preserved state generated from a stateful policy. + "disks": { # Preserved disks defined for this instance. + # This map is keyed with the device names of the disks. + "a_key": { + "autoDelete": "A String", # These stateful disks will never be deleted during autohealing, + # update, instance recreate operations. This flag is used to configure + # if the disk should be deleted after it is no longer used by the group, + # e.g. when the given instance or the whole MIG is deleted. + # Note: disks attached in READ_ONLY mode cannot be + # auto-deleted. + "mode": "A String", # The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the + # disk in READ_WRITE mode. + "source": "A String", # The URL of the disk resource that is stateful and should be attached + # to the VM instance. + }, + }, + "externalIPs": { # Preserved external IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "internalIPs": { # Preserved internal IPs defined for this instance. + # This map is keyed with the name of the network interface. + "a_key": { + "autoDelete": "A String", # These stateful IPs will never be released during autohealing, + # update or VM instance recreate operations. + # This flag is used to configure if the IP reservation should be deleted + # after it is no longer used by the group, e.g. when the given instance + # or the whole group is deleted. + "ipAddress": { # Ip address representation + "address": "A String", # The URL of the reservation for this IP address. + "literal": "A String", # An IPv4 internal network address to assign to the instance for this + # network interface. + }, + }, + }, + "metadata": { # Preserved metadata defined for this instance. + "a_key": "A String", + }, + }, + "status": "A String", # The status of applying this per-instance configuration on the corresponding + # managed instance. + }, + ], "kind": "compute#instanceGroupManagerResizeRequest", # Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. "name": "A String", # The name of this resize request. The name must be 1-63 characters # long, and comply withRFC1035. diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index e12f48a6e2..f87592f79c 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -87,10 +87,10 @@

Instance Methods

createInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Creates instances with per-instance configurations in this regional managed

- delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None)

+ delete(project, region, instanceGroupManager, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Deletes the specified managed instance group and all of the instances

- deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ deleteInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group to be

deletePerInstanceConfigs(project, region, instanceGroupManager, body=None, x__xgafv=None)

@@ -132,7 +132,7 @@

Instance Methods

patchPerInstanceConfigs(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Inserts or patches per-instance configurations for the managed instance

- recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ recreateInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified VM instances in the managed instance group to be

resize(project, region, instanceGroupManager, size, requestId=None, x__xgafv=None)

@@ -150,7 +150,7 @@

Instance Methods

startInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group to be

- stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+ stopInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)

Flags the specified instances in the managed instance group to be

suspendInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

@@ -1181,7 +1181,7 @@

Method Details

- delete(project, region, instanceGroupManager, requestId=None, x__xgafv=None) + delete(project, region, instanceGroupManager, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Deletes the specified managed instance group and all of the instances
 in that group.
 
@@ -1189,6 +1189,8 @@ 

Method Details

project: string, Project ID for this request. (required) region: string, Name of the region scoping this request. (required) instanceGroupManager: string, Name of the managed instance group to delete. (required) + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance deletion even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -1475,7 +1477,7 @@

Method Details

- deleteInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + deleteInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified instances in the managed instance group to be
 immediately deleted. The instances are also removed from any target
 pools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of
@@ -1513,6 +1515,8 @@ 

Method Details

# group's zone or region. } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance deletion even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -5277,6 +5281,32 @@

Method Details

# InstanceFlexibilityPolicy. "machineType": "A String", # Output only. The machine type to be used for this instance. }, + "scheduling": { # Output only. Information about the termination timestamp of the instance, if applicable. + "gracefulShutdownTimestamp": "A String", # Output only. The timestamp at which the underlying instance will be + # triggered for graceful shutdown if it is configured. This is in RFC3339 text format. + "terminationTimestamp": "A String", # Output only. The timestamp at which the managed instance will be terminated. This is + # in RFC3339 text + # format. + }, + "shutdownDetails": { # Output only. Specifies the graceful shutdown details if the instance is in + # `PENDING_STOP` state or there is a programmed stop scheduled. + "maxDuration": { # A Duration represents a fixed-length span of time represented # Output only. The duration for graceful shutdown. Only applicable when the instance is + # in `PENDING_STOP` state. + # as a count of seconds and fractions of seconds at nanosecond + # resolution. It is independent of any calendar and concepts like "day" + # or "month". Range is approximately 10,000 years. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. + # Durations less than one second are represented with a 0 + # `seconds` field and a positive `nanos` field. Must be from 0 + # to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 + # to 315,576,000,000 inclusive. Note: these bounds are computed from: + # 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + "requestTimestamp": "A String", # Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of + # instance in RFC3339 + # text format. + }, "version": { # Output only. [Output Only] Intended version of this instance. "instanceTemplate": "A String", # Output only. [Output Only] The intended template of the instance. This field is empty # when current_action is one of { DELETING, ABANDONING }. @@ -6959,7 +6989,7 @@

Method Details

- recreateInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + recreateInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified VM instances in the managed instance group to be
 immediately recreated. Each instance is recreated using the group's current
 configuration. This operation is marked as DONE when the flag
@@ -6988,6 +7018,8 @@ 

Method Details

], } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance recreation even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. @@ -8826,7 +8858,7 @@

Method Details

- stopInstances(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) + stopInstances(project, region, instanceGroupManager, body=None, noGracefulShutdown=None, requestId=None, x__xgafv=None)
Flags the specified instances in the managed instance group to be
 immediately stopped. You can only specify instances that are running in
 this request. This method reduces thetargetSize and increases the targetStoppedSize
@@ -8869,6 +8901,8 @@ 

Method Details

], } + noGracefulShutdown: boolean, When set, graceful shutdown is skipped for instance stopping even if it's +configured for the instances. requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index 01fd04f743..43f21d061d 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -905,6 +905,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -1854,6 +1856,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. @@ -3178,6 +3182,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 04bdae65ce..1ec69601fa 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -1003,6 +1003,8 @@

Method Details

"labels": { # Labels to apply to instances that are created from these properties. "a_key": "A String", }, + "localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the + # Local SSDs attached to the VM. "machineType": "A String", # The machine type to use for instances that are created from these # properties. # This field only accepts a machine type name, for example `n2-standard-4`. diff --git a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html index d153b0351d..88345ecd3f 100644 --- a/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_v1.regionNetworkFirewallPolicies.html @@ -455,7 +455,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -586,11 +588,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1578,7 +1581,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1709,11 +1714,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -1778,7 +1784,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -1909,11 +1917,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2029,7 +2038,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2160,11 +2171,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2216,7 +2228,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -2347,11 +2361,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -2959,7 +2974,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3090,11 +3107,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3196,7 +3214,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3327,11 +3347,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -3396,7 +3417,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -3527,11 +3550,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4023,7 +4047,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4154,11 +4180,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4223,7 +4250,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4354,11 +4383,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4522,7 +4552,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4653,11 +4685,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -4722,7 +4755,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -4853,11 +4888,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: @@ -5216,7 +5252,9 @@

Method Details

# the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. # Valid actions for firewall rules are: "allow", "deny", - # "apply_security_profile_group" and "goto_next". + # "apply_security_profile_group" and "goto_next" ( + # "apply_security_profile_group" can be specified only for global + # network firewall policies or hierarchical firewall policies). # Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" # and "goto_next". "description": "A String", # An optional description for this resource. @@ -5347,11 +5385,12 @@

Method Details

# and can be updated. "ruleTupleCount": 42, # Output only. [Output Only] Calculation of the complexity of a single firewall policy # rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfileGroup resource instance. # Example: # https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group # Must be specified if action is one of 'apply_security_profile_group' or - # 'mirror'. Cannot be specified for other actions. + # 'mirror'. Cannot be specified for other actions. Can be specified only + # for global network firewall policies or hierarchical firewall policies. "targetForwardingRules": [ # A list of forwarding rules to which this rule applies. # This field allows you to control which load balancers get this rule. # For example, the following are valid values: diff --git a/docs/dyn/compute_v1.routers.html b/docs/dyn/compute_v1.routers.html index 3e504242a3..26346f5031 100644 --- a/docs/dyn/compute_v1.routers.html +++ b/docs/dyn/compute_v1.routers.html @@ -86,12 +86,18 @@

Instance Methods

delete(project, region, router, requestId=None, x__xgafv=None)

Deletes the specified Router resource.

+

+ deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)

+

Deletes Named Set

deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)

Deletes Route Policy

get(project, region, router, x__xgafv=None)

Returns the specified Router resource.

+

+ getNamedSet(project, region, router, namedSet=None, x__xgafv=None)

+

Returns specified Named Set

getNatIpInfo(project, region, router, natName=None, x__xgafv=None)

Retrieves runtime NAT IP information.

@@ -119,6 +125,12 @@

Instance Methods

listBgpRoutes_next()

Retrieves the next page of results.

+

+ listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

Retrieves a list of router named set subresources available to the

+

+ listNamedSets_next()

+

Retrieves the next page of results.

listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves a list of router route policy subresources available to the

@@ -131,6 +143,9 @@

Instance Methods

patch(project, region, router, body=None, requestId=None, x__xgafv=None)

Patches the specified Router resource with the data included in the

+

+ patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)

+

Patches Named Set

patchRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)

Patches Route Policy

@@ -140,6 +155,9 @@

Instance Methods

update(project, region, router, body=None, requestId=None, x__xgafv=None)

Updates the specified Router resource with the data included in the

+

+ updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None)

+

Updates or creates new Named Set

updateRoutePolicy(project, region, router, body=None, requestId=None, x__xgafv=None)

Updates or creates new Route Policy

@@ -1152,14 +1170,14 @@

Method Details

- deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None) -
Deletes Route Policy
+    deleteNamedSet(project, region, router, namedSet=None, requestId=None, x__xgafv=None)
+  
Deletes Named Set
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  router: string, Name of the Router resource where Route Policy is defined. (required)
-  policy: string, The Policy name for this request. Name must conform to RFC1035
+  router: string, Name of the Router resource where Named Set is defined. (required)
+  namedSet: string, The Named Set name for this request. Name must conform to RFC1035
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
 that if you must retry your request, the server will know to ignore the
 request if it has already been completed.
@@ -1446,13 +1464,27 @@ 

Method Details

- get(project, region, router, x__xgafv=None) -
Returns the specified Router resource.
+    deleteRoutePolicy(project, region, router, policy=None, requestId=None, x__xgafv=None)
+  
Deletes Route Policy
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  router: string, Name of the Router resource to return. (required)
+  router: string, Name of the Router resource where Route Policy is defined. (required)
+  policy: string, The Policy name for this request. Name must conform to RFC1035
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1461,106 +1493,386 @@ 

Method Details

Returns: An object of the form: - { # Represents a Cloud Router resource. + { # Represents an Operation resource. # - # For more information about Cloud Router, read theCloud - # Router overview. - "bgp": { # BGP information specific to this router. - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - # The options are DEFAULT or CUSTOM. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These groups will be advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # is advertised to all peers of the router. - # These IP ranges will be advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/v1/globalOperations) + # * [Regional](/compute/docs/reference/rest/v1/regionOperations) + # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. }, ], - "asn": 42, # Local BGP Autonomous System Number (ASN). - # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The - # value will be fixed for this router resource. All VPN tunnels that link - # to this router will have the same local ASN. - "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It - # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at - # least /30, even if the BGP sessions are over IPv6. It must not overlap - # with any IPv4 BGP session ranges. - # - # - # Other vendors commonly call this "router ID". - "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are - # sent to the peer. - # - # - # Hold time is three times the interval at which keepalive messages are - # sent, and the hold time is the maximum number of seconds allowed to - # elapse between successive keepalive messages that BGP receives from a - # peer. - # - # - # BGP will use the smaller of either the local hold time value or the - # peer's hold time value as the hold time for the BGP connection between - # the two peers. - # - # - # If set, this value must be between 20 and 60. The default is 20. }, - "bgpPeers": [ # BGP information that must be configured into the routing stack to - # establish BGP peering. This information must specify the peer ASN and - # either the interface name, IP address, or peer IP address. Please refer toRFC4273. - { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: - # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. - # - # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. - "A String", - ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, - ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other + # appropriate identifiers. + "a_key": "A String", + }, + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate + # identifiers. + "a_key": "A String", + }, + }, + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is + # defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # 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). + "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. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: + # + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } + { + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. + }, + ], + "message": "A String", # [Output Only] A human-readable description of the warning code. + }, + ], + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}
+
+ +
+ get(project, region, router, x__xgafv=None) +
Returns the specified Router resource.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a Cloud Router resource.
+    #
+    # For more information about Cloud Router, read theCloud
+    # Router overview.
+  "bgp": { # BGP information specific to this router.
+    "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+        # The options are DEFAULT or CUSTOM.
+    "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+        # This field can only be populated if advertise_mode is CUSTOM and
+        # is advertised to all peers of the router.
+        # These groups will be advertised in addition to any specified prefixes.
+        # Leave this field blank to advertise no custom groups.
+      "A String",
+    ],
+    "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+        # This field can only be populated if advertise_mode is CUSTOM and
+        # is advertised to all peers of the router.
+        # These IP ranges will be advertised in addition to any specified groups.
+        # Leave this field blank to advertise no custom IP ranges.
+      { # Description-tagged IP ranges for the router to advertise.
+        "description": "A String", # User-specified description for the IP range.
+        "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+      },
+    ],
+    "asn": 42, # Local BGP Autonomous System Number (ASN).
+        # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+        # value will be fixed for this router resource. All VPN tunnels that link
+        # to this router will have the same local ASN.
+    "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+        # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+        # least /30, even if the BGP sessions are over IPv6. It must not overlap
+        # with any IPv4 BGP session ranges.
+        #
+        #
+        # Other vendors commonly call this "router ID".
+    "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+        # sent to the peer.
+        #
+        #
+        # Hold time is three times the interval at which keepalive messages are
+        # sent, and the hold time is the maximum number of seconds allowed to
+        # elapse between successive keepalive messages that BGP receives from a
+        # peer.
+        #
+        #
+        # BGP will use the smaller of either the local hold time value or the
+        # peer's hold time value as the hold time for the BGP connection between
+        # the two peers.
+        #
+        #
+        # If set, this value must be between 20 and 60. The default is 20.
+  },
+  "bgpPeers": [ # BGP information that must be configured into the routing stack to
+      # establish BGP peering. This information must specify the peer ASN and
+      # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+    {
+      "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+      "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+          # which currently supports the following option:
+          #
+          #    - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+          #    excludes any routes learned for subnets that use
+          #    VPC Network Peering.
+          #
+          #
+          # Note that this field can only be populated if advertise_mode is CUSTOM
+          # and overrides the list defined for the router (in the "bgp" message).
+          # These groups are advertised in addition to any specified prefixes.
+          # Leave this field blank to advertise no custom groups.
+        "A String",
+      ],
+      "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+          # This field can only be populated if advertise_mode is CUSTOM and
+          # overrides the list defined for the router (in the "bgp" message).
+          # These IP ranges are advertised in addition to any specified groups.
+          # Leave this field blank to advertise no custom IP ranges.
+        { # Description-tagged IP ranges for the router to advertise.
+          "description": "A String", # User-specified description for the IP range.
+          "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+        },
+      ],
+      "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+          # than one matching route of maximum length, the routes with the lowest
+          # priority value win.
+      "bfd": { # BFD configuration for the BGP peering.
+        "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+            # received from the peer router. The actual value is negotiated between
+            # the two routers and is equal to the greater of this value and the
+            # transmit interval of the other router.
+            #
+            #
+            # If set, this value must be between 1000 and 30000.
+            #
+            #
+            # The default is 1000.
+        "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+            # transmitted to the peer router. The actual value is negotiated between
+            # the two routers and is equal to the greater of this value and the
+            # corresponding receive interval of the other router.
+            #
             #
             # If set, this value must be between 1000 and 30000.
             #
@@ -1978,17 +2290,15 @@ 

Method Details

- getNatIpInfo(project, region, router, natName=None, x__xgafv=None) -
Retrieves runtime NAT IP information.
+    getNamedSet(project, region, router, namedSet=None, x__xgafv=None)
+  
Returns specified Named Set
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  router: string, Name of the Router resource to query for Nat IP information. The name
-should conform to RFC1035. (required)
-  natName: string, Name of the nat service to filter the NAT IP information.
-If it is omitted, all nats for this router will be returned.
-Name should conform to RFC1035.
+  router: string, Name of the Router resource to query for the named set. The name should
+conform to RFC1035. (required)
+  namedSet: string, The Named Set name for this request. Name must conform to RFC1035
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1998,7 +2308,91 @@ 

Method Details

An object of the form: { - "result": [ # [Output Only] A list of NAT IP information. + "etag": "A String", # end_interface: MixerGetResponseWithEtagBuilder + "resource": { + "description": "A String", # An optional description of named set. + "elements": [ # CEL expressions that are comparable to constructs of this set's type + # (see Policy Language). + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + ], + "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is + # essentially a hash of the Named Set used for optimistic locking. + # The fingerprint is initially generated by Compute Engine and changes + # after every request to modify or update the Named Set. You must always + # provide an up-to-date fingerprint hash in order to update or change + # labels. + # + # To see the latest fingerprint, make a getNamedSet() request + # to retrieve a Named Set. + "name": "A String", # This set's name, which must be a resource ID segment and unique within all + # named sets owned by the Router. Name should conform to RFC1035. + "type": "A String", # This named set's type + }, +}
+
+ +
+ getNatIpInfo(project, region, router, natName=None, x__xgafv=None) +
Retrieves runtime NAT IP information.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource to query for Nat IP information. The name
+should conform to RFC1035. (required)
+  natName: string, Name of the nat service to filter the NAT IP information.
+If it is omitted, all nats for this router will be returned.
+Name should conform to RFC1035.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "result": [ # [Output Only] A list of NAT IP information.
     { # Contains NAT IP information of a NAT config (i.e. usage status, mode).
       "natIpInfoMappings": [ # Output only. A list of all NAT IPs assigned to this NAT config.
         { # Contains information of a NAT IP.
@@ -4733,8 +5127,8 @@ 

Method Details

- listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
Retrieves a list of router route policy subresources available to the
+    listNamedSets(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Retrieves a list of router named set subresources available to the
 specified project.
 
 Args:
@@ -4837,121 +5231,71 @@ 

Method Details

"etag": "A String", "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is # defined by the server. - "kind": "compute#routersListRoutePolicies", # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies. + "kind": "compute#routersListNamedSets", # Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets. "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for # the query parameter pageToken in the next list request. # Subsequent list requests will have their own nextPageToken to # continue paging through the results. - "result": [ # [Output Only] A list of route policies. + "result": [ # [Output Only] A list of named sets. { - "description": "A String", # An optional description of route policy. - "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is - # essentially a hash of the Route Policy used for optimistic locking. + "description": "A String", # An optional description of named set. + "elements": [ # CEL expressions that are comparable to constructs of this set's type + # (see Policy Language). + { # Represents a textual expression in the Common Expression Language (CEL) + # syntax. CEL is a C-like expression language. The syntax and semantics of CEL + # are documented at https://github.com/google/cel-spec. + # + # Example (Comparison): + # + # title: "Summary size limit" + # description: "Determines if a summary is less than 100 chars" + # expression: "document.summary.size() < 100" + # + # Example (Equality): + # + # title: "Requestor is owner" + # description: "Determines if requestor is the document owner" + # expression: "document.owner == request.auth.claims.email" + # + # Example (Logic): + # + # title: "Public documents" + # description: "Determine whether the document should be publicly visible" + # expression: "document.type != 'private' && document.type != 'internal'" + # + # Example (Data Manipulation): + # + # title: "Notification string" + # description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" + # + # The exact variables and functions that may be referenced within an expression + # are determined by the service that evaluates it. See the service + # documentation for additional information. + "description": "A String", # Optional. Description of the expression. This is a longer text which + # describes the expression, e.g. when hovered over it in a UI. + "expression": "A String", # Textual representation of an expression in Common Expression Language + # syntax. + "location": "A String", # Optional. String indicating the location of the expression for error + # reporting, e.g. a file name and a position in the file. + "title": "A String", # Optional. Title for the expression, i.e. a short string describing + # its purpose. This can be used e.g. in UIs which allow to enter the + # expression. + }, + ], + "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is + # essentially a hash of the Named Set used for optimistic locking. # The fingerprint is initially generated by Compute Engine and changes - # after every request to modify or update Route Policy. You must always + # after every request to modify or update the Named Set. You must always # provide an up-to-date fingerprint hash in order to update or change # labels. # - # To see the latest fingerprint, make a getRoutePolicy() request - # to retrieve a Route Policy. - "name": "A String", # Route Policy name, which must be a resource ID segment and unique - # within all the router's Route Policies. Name should conform to RFC1035. - "terms": [ # List of terms (the order in the list is not important, they are evaluated - # in order of priority). Order of policies is not retained and might change - # when getting policy later. - { - "actions": [ # CEL expressions to evaluate to modify a route when this term matches. - { # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - ], - "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term - # applies. When not set, the term applies to all - # routes. - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # - # Example (Comparison): - # - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # - # Example (Equality): - # - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # - # Example (Logic): - # - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # - # Example (Data Manipulation): - # - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. - "description": "A String", # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. - "expression": "A String", # Textual representation of an expression in Common Expression Language - # syntax. - "location": "A String", # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. - "title": "A String", # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. - }, - "priority": 42, # The evaluation priority for this term, which must be between 0 - # (inclusive) and 2^31 (exclusive), and unique within the list. - }, - ], - "type": "A String", + # To see the latest fingerprint, make a getNamedSet() request + # to retrieve a Named Set. + "name": "A String", # This set's name, which must be a resource ID segment and unique within all + # named sets owned by the Router. Name should conform to RFC1035. + "type": "A String", # This named set's type }, ], "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource. @@ -4987,21 +5331,7 @@

Method Details

- listRoutePolicies_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.
-        
-
- -
- list_next() + listNamedSets_next()
Retrieves the next page of results.
 
         Args:
@@ -5015,532 +5345,1170 @@ 

Method Details

- patch(project, region, router, body=None, requestId=None, x__xgafv=None) -
Patches the specified Router resource with the data included in the
-request. This method supportsPATCH
-semantics and usesJSON merge
-patch format and processing rules.
+    listRoutePolicies(project, region, router, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+  
Retrieves a list of router route policy subresources available to the
+specified project.
 
 Args:
   project: string, Project ID for this request. (required)
   region: string, Name of the region for this request. (required)
-  router: string, Name of the Router resource to patch. (required)
-  body: object, The request body.
-    The object takes the form of:
+  router: string, Name or id of the resource for this request.
+Name should conform to RFC1035. (required)
+  filter: string, A filter expression that filters resources listed in the response. Most
+Compute resources support two types of filter expressions:
+expressions that support regular expressions and expressions that follow
+API improvement proposal AIP-160.
+These two types of filter expressions cannot be mixed in one request.
+
+If you want to use AIP-160, your expression must specify the field name, an
+operator, and the value that you want to use for filtering. The value
+must be a string, a number, or a boolean. The operator
+must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
+
+For example, if you are filtering Compute Engine instances, you can
+exclude instances named `example-instance` by specifying
+`name != example-instance`.
+
+The `:*` comparison can be used to test whether a key has been defined.
+For example, to find all objects with `owner` label use:
+```
+labels.owner:*
+```
+
+You can also filter nested fields. For example, you could specify
+`scheduling.automaticRestart = false` to include instances only
+if they are not scheduled for automatic restarts. You can use filtering
+on nested fields to filter based onresource labels.
+
+To filter on multiple expressions, provide each separate expression within
+parentheses. For example:
+```
+(scheduling.automaticRestart = true)
+(cpuPlatform = "Intel Skylake")
+```
+By default, each expression is an `AND` expression. However, you
+can include `AND` and `OR` expressions explicitly.
+For example:
+```
+(cpuPlatform = "Intel Skylake") OR
+(cpuPlatform = "Intel Broadwell") AND
+(scheduling.automaticRestart = true)
+```
+
+If you want to use a regular expression, use the `eq` (equal) or `ne`
+(not equal) operator against a single un-parenthesized expression with or
+without quotes or against multiple parenthesized expressions. Examples:
+
+`fieldname eq unquoted literal`
+`fieldname eq 'single quoted literal'`
+`fieldname eq "double quoted literal"`
+`(fieldname1 eq literal) (fieldname2 ne "literal")`
+
+The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
+The literal value must match the entire field.
+
+For example, to filter for instances that do not end with name "instance",
+you would use `name ne .*instance`.
+
+You cannot combine constraints on multiple fields using regular
+expressions.
+  maxResults: integer, The maximum number of results per page that should be returned.
+If the number of available results is larger than `maxResults`,
+Compute Engine returns a `nextPageToken` that can be used to get
+the next page of results in subsequent list requests. Acceptable values are
+`0` to `500`, inclusive. (Default: `500`)
+  orderBy: string, Sorts list results by a certain order. By default, results
+are returned in alphanumerical order based on the resource name.
+
+You can also sort results in descending order based on the creation
+timestamp using `orderBy="creationTimestamp desc"`. This sorts
+results based on the `creationTimestamp` field in
+reverse chronological order (newest result first). Use this to sort
+resources like operations so that the newest operation is returned first.
+
+Currently, only sorting by `name` or
+`creationTimestamp desc` is supported.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the
+`nextPageToken` returned by a previous list request to get
+the next page of results.
+  returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
+of failure. The default value is false.
+
+For example, when partial success behavior is enabled, aggregatedList for a
+single zone scope either returns all resources in the zone or no resources,
+with an error code.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
 
-{ # Represents a Cloud Router resource.
-    # 
-    # For more information about Cloud Router, read theCloud
-    # Router overview.
-  "bgp": { # BGP information specific to this router.
-    "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
-        # The options are DEFAULT or CUSTOM.
-    "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
-        # This field can only be populated if advertise_mode is CUSTOM and
-        # is advertised to all peers of the router.
-        # These groups will be advertised in addition to any specified prefixes.
-        # Leave this field blank to advertise no custom groups.
-      "A String",
-    ],
-    "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
-        # This field can only be populated if advertise_mode is CUSTOM and
-        # is advertised to all peers of the router.
-        # These IP ranges will be advertised in addition to any specified groups.
-        # Leave this field blank to advertise no custom IP ranges.
-      { # Description-tagged IP ranges for the router to advertise.
-        "description": "A String", # User-specified description for the IP range.
-        "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
-      },
-    ],
-    "asn": 42, # Local BGP Autonomous System Number (ASN).
-        # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
-        # value will be fixed for this router resource. All VPN tunnels that link
-        # to this router will have the same local ASN.
-    "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
-        # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
-        # least /30, even if the BGP sessions are over IPv6. It must not overlap
-        # with any IPv4 BGP session ranges.
-        #
-        #
-        # Other vendors commonly call this "router ID".
-    "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
-        # sent to the peer.
-        #
-        #
-        # Hold time is three times the interval at which keepalive messages are
-        # sent, and the hold time is the maximum number of seconds allowed to
-        # elapse between successive keepalive messages that BGP receives from a
-        # peer.
-        #
-        #
-        # BGP will use the smaller of either the local hold time value or the
-        # peer's hold time value as the hold time for the BGP connection between
-        # the two peers.
-        #
-        #
-        # If set, this value must be between 20 and 60. The default is 20.
-  },
-  "bgpPeers": [ # BGP information that must be configured into the routing stack to
-      # establish BGP peering. This information must specify the peer ASN and
-      # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
     {
-      "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
-      "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
-          # which currently supports the following option:
-          #
-          #    - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
-          #    excludes any routes learned for subnets that use
-          #    VPC Network Peering.
-          #
+  "etag": "A String",
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "kind": "compute#routersListRoutePolicies", # Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for
+      # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
+      # the query parameter pageToken in the next list request.
+      # Subsequent list requests will have their own nextPageToken to
+      # continue paging through the results.
+  "result": [ # [Output Only] A list of route policies.
+    {
+      "description": "A String", # An optional description of route policy.
+      "fingerprint": "A String", # A fingerprint for the Route Policy being applied to this Router, which is
+          # essentially a hash of the Route Policy used for optimistic locking.
+          # The fingerprint is initially generated by Compute Engine and changes
+          # after every request to modify or update Route Policy. You must always
+          # provide an up-to-date fingerprint hash in order to update or change
+          # labels.
           #
-          # Note that this field can only be populated if advertise_mode is CUSTOM
-          # and overrides the list defined for the router (in the "bgp" message).
-          # These groups are advertised in addition to any specified prefixes.
-          # Leave this field blank to advertise no custom groups.
-        "A String",
-      ],
-      "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
-          # This field can only be populated if advertise_mode is CUSTOM and
-          # overrides the list defined for the router (in the "bgp" message).
-          # These IP ranges are advertised in addition to any specified groups.
-          # Leave this field blank to advertise no custom IP ranges.
-        { # Description-tagged IP ranges for the router to advertise.
-          "description": "A String", # User-specified description for the IP range.
-          "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
-        },
-      ],
-      "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
-          # than one matching route of maximum length, the routes with the lowest
-          # priority value win.
-      "bfd": { # BFD configuration for the BGP peering.
-        "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
-            # received from the peer router. The actual value is negotiated between
-            # the two routers and is equal to the greater of this value and the
-            # transmit interval of the other router.
-            #
-            #
-            # If set, this value must be between 1000 and 30000.
-            #
-            #
-            # The default is 1000.
-        "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
-            # transmitted to the peer router. The actual value is negotiated between
-            # the two routers and is equal to the greater of this value and the
-            # corresponding receive interval of the other router.
-            #
-            #
-            # If set, this value must be between 1000 and 30000.
-            #
-            #
-            # The default is 1000.
-        "multiplier": 42, # The number of consecutive BFD packets that must be missed
-            # before BFD declares that a peer is unavailable.
-            #
-            #
-            # If set, the value must be a value between 5 and 16.
-            #
-            #
-            # The default is 5.
-        "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
-            #
-            #
-            # If set to ACTIVE, the Cloud Router will initiate the BFD session for
-            # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
-            # peer router to initiate the BFD session for this BGP peer. If set to
-            # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
-      },
-      "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
-          # session.
+          # To see the latest fingerprint, make a getRoutePolicy() request
+          # to retrieve a Route Policy.
+      "name": "A String", # Route Policy name, which must be a resource ID segment and unique
+          # within all the router's Route Policies. Name should conform to RFC1035.
+      "terms": [ # List of terms (the order in the list is not important, they are evaluated
+          # in order of priority). Order of policies is not retained and might change
+          # when getting policy later.
         {
-          "range": "A String", # The custom learned route IP address range. Must be a valid
-              # CIDR-formatted prefix. If an IP address is provided without a subnet
-              # mask, it is interpreted as, for IPv4, a `/32` singular IP address
-              # range, and, for IPv6, `/128`.
-        },
-      ],
-      "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This
-          # value is applied to all custom learned route ranges for the session.
-          # You can choose a value from `0` to `65335`. If you don't provide a
-          # value, Google Cloud assigns a priority of `100` to the ranges.
-      "enable": "A String", # The status of the BGP peer connection.
-          #
-          #
-          # If set to FALSE, any active session with the peer is terminated and
-          # all associated routing information is removed. If set to TRUE, the
-          # peer connection can be established with routing information. The default
-          # is TRUE.
-      "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
-          # the peerIpAddress is version 4.
-      "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
-          # peerIpAddress is version 6.
-      "exportPolicies": [ # List of export policies applied to this peer, in the order they must be
-          # evaluated. The name must correspond to an existing policy that has
-          # ROUTE_POLICY_TYPE_EXPORT type.
-        "A String",
-      ],
-      "importPolicies": [ # List of import policies applied to this peer, in the order they must be
-          # evaluated. The name must correspond to an existing policy that has
-          # ROUTE_POLICY_TYPE_IMPORT type.
-        "A String",
+          "actions": [ # CEL expressions to evaluate to modify a route when this term matches.
+            { # Represents a textual expression in the Common Expression Language (CEL)
+                # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+                # are documented at https://github.com/google/cel-spec.
+                #
+                # Example (Comparison):
+                #
+                #     title: "Summary size limit"
+                #     description: "Determines if a summary is less than 100 chars"
+                #     expression: "document.summary.size() < 100"
+                #
+                # Example (Equality):
+                #
+                #     title: "Requestor is owner"
+                #     description: "Determines if requestor is the document owner"
+                #     expression: "document.owner == request.auth.claims.email"
+                #
+                # Example (Logic):
+                #
+                #     title: "Public documents"
+                #     description: "Determine whether the document should be publicly visible"
+                #     expression: "document.type != 'private' && document.type != 'internal'"
+                #
+                # Example (Data Manipulation):
+                #
+                #     title: "Notification string"
+                #     description: "Create a notification string with a timestamp."
+                #     expression: "'New message received at ' + string(document.create_time)"
+                #
+                # The exact variables and functions that may be referenced within an expression
+                # are determined by the service that evaluates it. See the service
+                # documentation for additional information.
+              "description": "A String", # Optional. Description of the expression. This is a longer text which
+                  # describes the expression, e.g. when hovered over it in a UI.
+              "expression": "A String", # Textual representation of an expression in Common Expression Language
+                  # syntax.
+              "location": "A String", # Optional. String indicating the location of the expression for error
+                  # reporting, e.g. a file name and a position in the file.
+              "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+                  # its purpose. This can be used e.g. in UIs which allow to enter the
+                  # expression.
+            },
+          ],
+          "match": { # Represents a textual expression in the Common Expression Language (CEL) # CEL expression evaluated against a route to determine if this term
+              # applies. When not set, the term applies to all
+              # routes.
+              # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+              # are documented at https://github.com/google/cel-spec.
+              #
+              # Example (Comparison):
+              #
+              #     title: "Summary size limit"
+              #     description: "Determines if a summary is less than 100 chars"
+              #     expression: "document.summary.size() < 100"
+              #
+              # Example (Equality):
+              #
+              #     title: "Requestor is owner"
+              #     description: "Determines if requestor is the document owner"
+              #     expression: "document.owner == request.auth.claims.email"
+              #
+              # Example (Logic):
+              #
+              #     title: "Public documents"
+              #     description: "Determine whether the document should be publicly visible"
+              #     expression: "document.type != 'private' && document.type != 'internal'"
+              #
+              # Example (Data Manipulation):
+              #
+              #     title: "Notification string"
+              #     description: "Create a notification string with a timestamp."
+              #     expression: "'New message received at ' + string(document.create_time)"
+              #
+              # The exact variables and functions that may be referenced within an expression
+              # are determined by the service that evaluates it. See the service
+              # documentation for additional information.
+            "description": "A String", # Optional. Description of the expression. This is a longer text which
+                # describes the expression, e.g. when hovered over it in a UI.
+            "expression": "A String", # Textual representation of an expression in Common Expression Language
+                # syntax.
+            "location": "A String", # Optional. String indicating the location of the expression for error
+                # reporting, e.g. a file name and a position in the file.
+            "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+                # its purpose. This can be used e.g. in UIs which allow to enter the
+                # expression.
+          },
+          "priority": 42, # The evaluation priority for this term, which must be between 0
+              # (inclusive) and 2^31 (exclusive), and unique within the list.
+        },
       ],
-      "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
-      "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
-      "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
-      "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
-      "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer.
-          #
-          #    -  MANAGED_BY_USER is the default value and can be managed by you
-          #    or other users
-          #    - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
-          #    by Cloud Interconnect, specifically by an InterconnectAttachment of type
-          #    PARTNER. Google automatically creates, updates, and deletes this type of
-          #    BGP peer when the PARTNER InterconnectAttachment is created, updated,
-          #    or deleted.
-      "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the
-          # name of one of the entries in the Router.md5_authentication_keys. The
-          # field must comply with RFC1035.
-      "name": "A String", # Name of this BGP peer.
-          # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
-          # characters long and match the regular expression
-          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
-          # lowercase letter, and all following characters must be a dash, lowercase
-          # letter, or digit, except the last character, which cannot be a dash.
-      "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
-          # a different value.
-      "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform.
-      "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform.
-      "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform.
-      "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router
-          # appliances such as Next Gen Firewalls, Virtual Routers, or Router
-          # Appliances. The VM instance must be located in zones contained in the
-          # same region as this Cloud Router.
-          # The VM instance is the peer side of the BGP session.
+      "type": "A String",
     },
   ],
-  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
-      # text format.
-  "description": "A String", # An optional description of this resource. Provide this property when you
-      # create the resource.
-  "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN
-      # attachments (interconnectAttachments).
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
-      # defined by the server.
-  "interfaces": [ # Router interfaces.
-      # To create a BGP peer that uses a router interface,
-      # the interface must have one of the following fields specified:
-      # 
-      #    - linkedVpnTunnel
-      #    - linkedInterconnectAttachment
-      #    - subnetwork
-      # 
-      # 
-      # You can create a router interface without any of these fields specified.
-      # However, you cannot create a BGP peer that uses that interface.
-    {
-      "ipRange": "A String", # IP address and range of the interface.
-          #
-          #    - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
-          #    be a CIDR-formatted string, for example, 169.254.0.1/30.
-          #    Note: Do not truncate the IP address, as it represents the IP address of
-          #    the interface.
-          #    - For Internet Protocol version 6 (IPv6), the value
-          #    must be a unique local address (ULA) range from fdff:1::/64
-          #    with a mask length of 126 or less. This value should be a CIDR-formatted
-          #    string, for example, fdff:1::1/112. Within the router's
-          #    VPC, this IPv6 prefix will be reserved exclusively for this connection
-          #    and cannot be used for any other purpose.
-      "ipVersion": "A String", # IP version of this interface.
-      "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region
-          # as the router. Each interface can have one linked resource, which can be
-          # a VPN tunnel, an Interconnect attachment, or a subnetwork.
-      "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the
-          # router. Each interface can have one linked resource, which can be
-          # a VPN tunnel, an Interconnect attachment, or a subnetwork.
-      "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface.
-          #
-          #    - MANAGED_BY_USER is the default value and can be managed directly
-          #    by users.
-          #    - MANAGED_BY_ATTACHMENT is an interface that is configured and
-          #    managed by Cloud Interconnect, specifically, by an InterconnectAttachment
-          #    of type PARTNER. Google automatically creates, updates, and deletes
-          #    this type of interface when the PARTNER InterconnectAttachment is
-          #    created, updated, or deleted.
-      "name": "A String", # Name of this interface entry.
-          # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
-          # characters long and match the regular expression
-          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
-          # lowercase letter, and all following characters must be a dash, lowercase
-          # letter, or digit, except the last character, which cannot be a dash.
-      "privateIpAddress": "A String", # The regional private internal IP address that is used to establish
-          # BGP sessions to a VM instance acting as a third-party
-          # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
-          # an SD-WAN VM.
-      "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface
-          # you are creating. The redundantInterface must belong to the same Cloud
-          # Router as the interface here. To establish the BGP session to a Router
-          # Appliance VM, you must create two BGP peers. The two BGP peers must be
-          # attached to two separate interfaces that are redundant with each other.
-          # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
-          # be 1-63 characters long and match the regular expression
-          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
-          # lowercase letter, and all following characters must be a dash, lowercase
-          # letter, or digit, except the last character, which cannot be a dash.
-      "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which
-          # must be in the same region as the Cloud Router.
-          # When you establish a BGP session to a VM instance using this interface,
-          # the VM instance must belong to the same subnetwork as the subnetwork
-          # specified here.
-    },
+  "selfLink": "A String", # Output only. [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # Output only. [Output Only] Unreachable resources.
+    "A String",
   ],
-  "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
-      # routers.
-  "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
-    {
-      "key": "A String", # [Input only] Value of the key.
-          #
-          # For patch and update calls, it can be skipped to
-          # copy the value from the previous configuration. This is allowed if the
-          # key with the same name existed before the operation. Maximum length is 80
-          # characters. Can only contain printable ASCII characters.
-      "name": "A String", # Name used to identify the key.
-          #
-          # Must be unique within a router. Must be referenced by exactly
-          # one bgpPeer. Must comply withRFC1035.
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+        # Engine returns NO_RESULTS_ON_PAGE if there
+        # are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key:
+        # value format. For example:
+        #
+        # "data": [
+        #   {
+        #    "key": "scope",
+        #    "value": "zones/us-east1-d"
+        #   }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being
+            # returned. For example, for warnings where there are no results in a list
+            # request for a particular zone, this key might be scope and
+            # the key value might be the zone name. Other examples might be a key
+            # indicating a deprecated resource and a suggested replacement, or a
+            # warning about invalid network settings (for example, if an instance
+            # attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ listRoutePolicies_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.
+        
+
+ +
+ 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(project, region, router, body=None, requestId=None, x__xgafv=None) +
Patches the specified Router resource with the data included in the
+request. This method supportsPATCH
+semantics and usesJSON merge
+patch format and processing rules.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource to patch. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Cloud Router resource.
+    # 
+    # For more information about Cloud Router, read theCloud
+    # Router overview.
+  "bgp": { # BGP information specific to this router.
+    "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+        # The options are DEFAULT or CUSTOM.
+    "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode.
+        # This field can only be populated if advertise_mode is CUSTOM and
+        # is advertised to all peers of the router.
+        # These groups will be advertised in addition to any specified prefixes.
+        # Leave this field blank to advertise no custom groups.
+      "A String",
+    ],
+    "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+        # This field can only be populated if advertise_mode is CUSTOM and
+        # is advertised to all peers of the router.
+        # These IP ranges will be advertised in addition to any specified groups.
+        # Leave this field blank to advertise no custom IP ranges.
+      { # Description-tagged IP ranges for the router to advertise.
+        "description": "A String", # User-specified description for the IP range.
+        "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+      },
+    ],
+    "asn": 42, # Local BGP Autonomous System Number (ASN).
+        # Must be anRFC6996 private ASN, either 16-bit or 32-bit. The
+        # value will be fixed for this router resource. All VPN tunnels that link
+        # to this router will have the same local ASN.
+    "identifierRange": "A String", # Explicitly specifies a range of valid BGP Identifiers for this Router. It
+        # is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at
+        # least /30, even if the BGP sessions are over IPv6. It must not overlap
+        # with any IPv4 BGP session ranges.
+        #
+        #
+        # Other vendors commonly call this "router ID".
+    "keepaliveInterval": 42, # The interval in seconds between BGP keepalive messages that are
+        # sent to the peer.
+        #
+        #
+        # Hold time is three times the interval at which keepalive messages are
+        # sent, and the hold time is the maximum number of seconds allowed to
+        # elapse between successive keepalive messages that BGP receives from a
+        # peer.
+        #
+        #
+        # BGP will use the smaller of either the local hold time value or the
+        # peer's hold time value as the hold time for the BGP connection between
+        # the two peers.
+        #
+        #
+        # If set, this value must be between 20 and 60. The default is 20.
+  },
+  "bgpPeers": [ # BGP information that must be configured into the routing stack to
+      # establish BGP peering. This information must specify the peer ASN and
+      # either the interface name, IP address, or peer IP address. Please refer toRFC4273.
+    {
+      "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement.
+      "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode,
+          # which currently supports the following option:
+          #
+          #    - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This
+          #    excludes any routes learned for subnets that use
+          #    VPC Network Peering.
+          #
+          #
+          # Note that this field can only be populated if advertise_mode is CUSTOM
+          # and overrides the list defined for the router (in the "bgp" message).
+          # These groups are advertised in addition to any specified prefixes.
+          # Leave this field blank to advertise no custom groups.
+        "A String",
+      ],
+      "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode.
+          # This field can only be populated if advertise_mode is CUSTOM and
+          # overrides the list defined for the router (in the "bgp" message).
+          # These IP ranges are advertised in addition to any specified groups.
+          # Leave this field blank to advertise no custom IP ranges.
+        { # Description-tagged IP ranges for the router to advertise.
+          "description": "A String", # User-specified description for the IP range.
+          "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string.
+        },
+      ],
+      "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more
+          # than one matching route of maximum length, the routes with the lowest
+          # priority value win.
+      "bfd": { # BFD configuration for the BGP peering.
+        "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+            # received from the peer router. The actual value is negotiated between
+            # the two routers and is equal to the greater of this value and the
+            # transmit interval of the other router.
+            #
+            #
+            # If set, this value must be between 1000 and 30000.
+            #
+            #
+            # The default is 1000.
+        "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets
+            # transmitted to the peer router. The actual value is negotiated between
+            # the two routers and is equal to the greater of this value and the
+            # corresponding receive interval of the other router.
+            #
+            #
+            # If set, this value must be between 1000 and 30000.
+            #
+            #
+            # The default is 1000.
+        "multiplier": 42, # The number of consecutive BFD packets that must be missed
+            # before BFD declares that a peer is unavailable.
+            #
+            #
+            # If set, the value must be a value between 5 and 16.
+            #
+            #
+            # The default is 5.
+        "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer.
+            #
+            #
+            # If set to ACTIVE, the Cloud Router will initiate the BFD session for
+            # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the
+            # peer router to initiate the BFD session for this BGP peer. If set to
+            # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED.
+      },
+      "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP
+          # session.
+        {
+          "range": "A String", # The custom learned route IP address range. Must be a valid
+              # CIDR-formatted prefix. If an IP address is provided without a subnet
+              # mask, it is interpreted as, for IPv4, a `/32` singular IP address
+              # range, and, for IPv6, `/128`.
+        },
+      ],
+      "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This
+          # value is applied to all custom learned route ranges for the session.
+          # You can choose a value from `0` to `65335`. If you don't provide a
+          # value, Google Cloud assigns a priority of `100` to the ranges.
+      "enable": "A String", # The status of the BGP peer connection.
+          #
+          #
+          # If set to FALSE, any active session with the peer is terminated and
+          # all associated routing information is removed. If set to TRUE, the
+          # peer connection can be established with routing information. The default
+          # is TRUE.
+      "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if
+          # the peerIpAddress is version 4.
+      "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the
+          # peerIpAddress is version 6.
+      "exportPolicies": [ # List of export policies applied to this peer, in the order they must be
+          # evaluated. The name must correspond to an existing policy that has
+          # ROUTE_POLICY_TYPE_EXPORT type.
+        "A String",
+      ],
+      "importPolicies": [ # List of import policies applied to this peer, in the order they must be
+          # evaluated. The name must correspond to an existing policy that has
+          # ROUTE_POLICY_TYPE_IMPORT type.
+        "A String",
+      ],
+      "interfaceName": "A String", # Name of the interface the BGP peer is associated with.
+      "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform.
+      "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform.
+      "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform.
+      "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer.
+          #
+          #    -  MANAGED_BY_USER is the default value and can be managed by you
+          #    or other users
+          #    - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed
+          #    by Cloud Interconnect, specifically by an InterconnectAttachment of type
+          #    PARTNER. Google automatically creates, updates, and deletes this type of
+          #    BGP peer when the PARTNER InterconnectAttachment is created, updated,
+          #    or deleted.
+      "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the
+          # name of one of the entries in the Router.md5_authentication_keys. The
+          # field must comply with RFC1035.
+      "name": "A String", # Name of this BGP peer.
+          # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+          # characters long and match the regular expression
+          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+          # lowercase letter, and all following characters must be a dash, lowercase
+          # letter, or digit, except the last character, which cannot be a dash.
+      "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use
+          # a different value.
+      "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform.
+      "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform.
+      "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform.
+      "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router
+          # appliances such as Next Gen Firewalls, Virtual Routers, or Router
+          # Appliances. The VM instance must be located in zones contained in the
+          # same region as this Cloud Router.
+          # The VM instance is the peer side of the BGP session.
+    },
+  ],
+  "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339
+      # text format.
+  "description": "A String", # An optional description of this resource. Provide this property when you
+      # create the resource.
+  "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN
+      # attachments (interconnectAttachments).
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is
+      # defined by the server.
+  "interfaces": [ # Router interfaces.
+      # To create a BGP peer that uses a router interface,
+      # the interface must have one of the following fields specified:
+      # 
+      #    - linkedVpnTunnel
+      #    - linkedInterconnectAttachment
+      #    - subnetwork
+      # 
+      # 
+      # You can create a router interface without any of these fields specified.
+      # However, you cannot create a BGP peer that uses that interface.
+    {
+      "ipRange": "A String", # IP address and range of the interface.
+          #
+          #    - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must
+          #    be a CIDR-formatted string, for example, 169.254.0.1/30.
+          #    Note: Do not truncate the IP address, as it represents the IP address of
+          #    the interface.
+          #    - For Internet Protocol version 6 (IPv6), the value
+          #    must be a unique local address (ULA) range from fdff:1::/64
+          #    with a mask length of 126 or less. This value should be a CIDR-formatted
+          #    string, for example, fdff:1::1/112. Within the router's
+          #    VPC, this IPv6 prefix will be reserved exclusively for this connection
+          #    and cannot be used for any other purpose.
+      "ipVersion": "A String", # IP version of this interface.
+      "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region
+          # as the router. Each interface can have one linked resource, which can be
+          # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+      "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the
+          # router. Each interface can have one linked resource, which can be
+          # a VPN tunnel, an Interconnect attachment, or a subnetwork.
+      "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface.
+          #
+          #    - MANAGED_BY_USER is the default value and can be managed directly
+          #    by users.
+          #    - MANAGED_BY_ATTACHMENT is an interface that is configured and
+          #    managed by Cloud Interconnect, specifically, by an InterconnectAttachment
+          #    of type PARTNER. Google automatically creates, updates, and deletes
+          #    this type of interface when the PARTNER InterconnectAttachment is
+          #    created, updated, or deleted.
+      "name": "A String", # Name of this interface entry.
+          # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63
+          # characters long and match the regular expression
+          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+          # lowercase letter, and all following characters must be a dash, lowercase
+          # letter, or digit, except the last character, which cannot be a dash.
+      "privateIpAddress": "A String", # The regional private internal IP address that is used to establish
+          # BGP sessions to a VM instance acting as a third-party
+          # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or
+          # an SD-WAN VM.
+      "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface
+          # you are creating. The redundantInterface must belong to the same Cloud
+          # Router as the interface here. To establish the BGP session to a Router
+          # Appliance VM, you must create two BGP peers. The two BGP peers must be
+          # attached to two separate interfaces that are redundant with each other.
+          # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must
+          # be 1-63 characters long and match the regular expression
+          # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a
+          # lowercase letter, and all following characters must be a dash, lowercase
+          # letter, or digit, except the last character, which cannot be a dash.
+      "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which
+          # must be in the same region as the Cloud Router.
+          # When you establish a BGP session to a VM instance using this interface,
+          # the VM instance must belong to the same subnetwork as the subnetwork
+          # specified here.
+    },
+  ],
+  "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for
+      # routers.
+  "md5AuthenticationKeys": [ # Keys used for MD5 authentication.
+    {
+      "key": "A String", # [Input only] Value of the key.
+          #
+          # For patch and update calls, it can be skipped to
+          # copy the value from the previous configuration. This is allowed if the
+          # key with the same name existed before the operation. Maximum length is 80
+          # characters. Can only contain printable ASCII characters.
+      "name": "A String", # Name used to identify the key.
+          #
+          # Must be unique within a router. Must be referenced by exactly
+          # one bgpPeer. Must comply withRFC1035.
+    },
+  ],
+  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
+      # The name must be 1-63 characters long, and comply withRFC1035.
+      # Specifically, the name must be 1-63 characters long and match the regular
+      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
+      # character must be a lowercase letter, and all following characters must
+      # be a dash, lowercase letter, or digit, except the last character, which
+      # cannot be a dash.
+  "nats": [ # A list of NAT services created in this router.
+    { # Represents a Nat resource. It enables the VMs within the specified
+        # subnetworks to access Internet without external IP addresses. It specifies
+        # a list of subnetworks (and the ranges within) that want to use NAT.
+        # Customers can also provide the external IPs that would be used for NAT. GCP
+        # would auto-allocate ephemeral IPs if no external IPs are provided.
+      "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
+          # Must be one of: PREMIUM, STANDARD.
+          # If not specified, then the current
+          # project-level default tier is used.
+      "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
+          # must be valid static external IPs that have been assigned to the NAT.
+          # These IPs should be used for updating/patching a NAT only.
+        "A String",
+      ],
+      "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
+          # state. This value is equal to tcp_time_wait_timeout_sec.
+          # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or
+          # 120s. The field is output only.
+      "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
+          #
+          #
+          # If not specified, it is disabled by default.
+          #
+          #
+          # If set to true,
+          #
+          #    - Dynamic Port Allocation will be enabled on this NAT
+          #    config.
+          #    - enableEndpointIndependentMapping cannot be set to true.
+          #    - If minPorts is set, minPortsPerVm must be set to a
+          #    power of two greater than or equal to 32. If minPortsPerVm is not set, a
+          #    minimum of 32 ports will be allocated to a VM from this NAT
+          #    config.
+      "enableEndpointIndependentMapping": True or False,
+      "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
+          # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
+        "A String",
+      ],
+      "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
+      "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
+        "enable": True or False, # Indicates whether or not to export logs. This is false by default.
+        "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
+            # logs are exported for all connections handled by this NAT.
+            # This option can take one of the following values:
+            #
+            #    - ERRORS_ONLY: Export logs only for connection failures.
+            #    - TRANSLATIONS_ONLY: Export logs only for successful
+            #    connections.
+            #    - ALL: Export logs for all connections, successful and
+            #    unsuccessful.
+      },
+      "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
+          # Dynamic Port Allocation is enabled.
+          #
+          #
+          # If Dynamic Port Allocation is not enabled, this field has no effect.
+          #
+          #
+          # If Dynamic Port Allocation is enabled, and this field is set, it must be
+          # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
+          # is not set.
+          #
+          #
+          # If Dynamic Port Allocation is enabled and this field is not set,
+          # a maximum of 65536 ports will be allocated to a VM from this NAT
+          # config.
+      "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
+          # set, a default number of ports is allocated to a VM. This is rounded
+          # up to the nearest power of 2. For example, if the value of this field is
+          # 50, at least 64 ports are allocated to a VM.
+      "name": "A String", # Unique name of this Nat service.
+          # The name must be 1-63 characters long and comply withRFC1035.
+      "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
+          # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
+          # selected for the SubnetworkIpRangeToNat64Option above.
+        { # Specifies a subnetwork to enable NAT64.
+          "name": "A String", # URL for the subnetwork resource that will use NAT64.
+        },
+      ],
+      "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
+          # values:
+          #
+          #    - MANUAL_ONLY: Uses only Nat IP addresses provided by
+          #    customers. When there are not enough specified Nat IPs, the Nat service
+          #    fails for new VMs.
+          #    - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
+          #    can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
+          #    be empty.
+      "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
+          # addresses must be valid static external IP addresses assigned to the
+          # project.
+        "A String",
+      ],
+      "rules": [ # A list of rules associated with this NAT.
+        {
+          "action": { # The action to be enforced for traffic that matches this rule.
+            "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
+                # addresses must be valid static external IP addresses assigned to the
+                # project.
+                # This field is used for public NAT.
+              "A String",
+            ],
+            "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
+                # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
+                # This field is used for private NAT.
+              "A String",
+            ],
+            "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
+                # must be valid static external IPs that have been assigned to the NAT.
+                # These IPs should be used for updating/patching a NAT rule only.
+                # This field is used for public NAT.
+              "A String",
+            ],
+            "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
+                # drained. This is only supported on patch/update, and these
+                # subnetworks must have previously been used as active ranges in this
+                # NAT Rule.
+                # This field is used for private NAT.
+              "A String",
+            ],
+          },
+          "description": "A String", # An optional description of this rule.
+          "match": "A String", # CEL expression that specifies the match condition that egress traffic
+              # from a VM is evaluated against. If it evaluates to true, the
+              # corresponding `action` is enforced.
+              #
+              # The following examples are valid match expressions for public NAT:
+              #
+              # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
+              #      '2.2.0.0/16')`
+              #
+              # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
+              #
+              # The following example is a valid match expression for private NAT:
+              #
+              # `nexthop.hub ==
+              # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
+          "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
+              # must be a positive value between 0 and 65000, and
+              # must be unique among rules within a NAT.
+        },
+      ],
+      "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
+          #
+          #    - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
+          #    Subnetwork are allowed to Nat.
+          #    - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
+          #    in every Subnetwork are allowed to Nat.
+          #    - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+          #    (specified in the field subnetwork below)
+          #
+          #
+          # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
+          # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
+          # should not be any other Router.Nat section in any Router for this network
+          # in this region.
+      "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
+          # values:
+          #
+          #    - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
+          #    every Subnetwork are allowed to Nat.
+          #    - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
+          #    (specified in the field nat64_subnetwork below)
+          #
+          #
+          # The default is NAT64_OPTION_UNSPECIFIED.
+          # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
+          # Router.Nat section in this region can also enable NAT64 for any
+          # Subnetworks in this network. Other Router.Nat sections can still be
+          # present to enable NAT44 only.
+      "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
+          # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
+          # SubnetworkIpRangeToNatOption above.
+        { # Defines the IP ranges that want to use NAT for a subnetwork.
+          "name": "A String", # URL for the subnetwork resource that will use NAT.
+          "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
+              # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
+              # is one of the values in source_ip_ranges_to_nat.
+            "A String",
+          ],
+          "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
+              # options of a single value are valid except
+              # NAT_IP_RANGE_OPTION_UNSPECIFIED.
+              # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
+              # "LIST_OF_SECONDARY_IP_RANGES"]
+              # Default: [ALL_IP_RANGES]
+            "A String",
+          ],
+        },
+      ],
+      "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
+          # if not set.
+      "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
+          # Defaults to 120s if not set.
+      "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
+          # not set.
+      "type": "A String", # Indicates whether this NAT is used for public or private IP
+          # translation. If unspecified, it defaults to PUBLIC.
+      "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+    },
+  ],
+  "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
+  "network": "A String", # URI of the network to which this router belongs.
+  "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
+      # as part of resource payload.
+    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
+        # The field is allowed for INSERT
+        # only. The keys/values to set on the resource should be specified in
+        # either ID { : } or Namespaced format
+        # { : }.
+        # For example the following are valid inputs:
+        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
+        # * {"123/environment" : "production", "345/abc" : "xyz"}
+        # Note:
+        # * Invalid combinations of ID & namespaced format is not supported. For
+        #   instance: {"123/environment" : "tagValues/444"} is invalid.
+        # * Inconsistent format is not supported. For instance:
+        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
+      "a_key": "A String",
+    },
+  },
+  "region": "A String", # [Output Only] URI of the region where the router resides.
+      # You must specify this field as part of the HTTP request URL. It is
+      # not settable as a field in the request body.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so
+that if you must retry your request, the server will know to ignore the
+request if it has already been completed.
+
+For example, consider a situation where you make an initial request and
+the request times out. If you make the request again with the same
+request ID, the server can check if original operation with the same
+request ID was received, and if so, will ignore the second request. This
+prevents clients from accidentally creating duplicate commitments.
+
+The request ID must be
+a valid UUID with the exception that zero UUID is not supported
+(00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource.
+    #
+    # Google Compute Engine has three Operation resources:
+    #
+    # * [Global](/compute/docs/reference/rest/v1/globalOperations)
+    # * [Regional](/compute/docs/reference/rest/v1/regionOperations)
+    # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations)
+    #
+    # You can use an operation resource to manage asynchronous API requests.
+    # For more information, readHandling
+    # API responses.
+    #
+    # Operations can be global, regional or zonal.
+    #
+    #    - For global operations, use the `globalOperations`
+    #    resource.
+    #    - For regional operations, use the
+    #    `regionOperations` resource.
+    #    - For zonal operations, use
+    #    the `zoneOperations` resource.
+    #
+    #
+    #
+    # For more information, read
+    # Global, Regional, and Zonal Resources.
+    #
+    # Note that completed Operation resources have a limited
+    # retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request.
+      # Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is
+      # set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339
+      # text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation,
+      # this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this
+        # operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error
+            # details. There is a set of defined message types to use for providing
+            # details.The syntax depends on the error code. For example,
+            # QuotaExceededInfo will have details when the error code is
+            # QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details.
+                #
+                # Example of an error when contacting the "pubsub.googleapis.com" API when it
+                # is not enabled:
+                #
+                #     { "reason": "API_DISABLED"
+                #       "domain": "googleapis.com"
+                #       "metadata": {
+                #         "resource": "projects/123",
+                #         "service": "pubsub.googleapis.com"
+                #       }
+                #     }
+                #
+                # This response indicates that the pubsub.googleapis.com API is not enabled.
+                #
+                # Example of an error that is returned when attempting to create a Spanner
+                # instance in a region that is out of stock:
+                #
+                #     { "reason": "STOCKOUT"
+                #       "domain": "spanner.googleapis.com",
+                #       "metadata": {
+                #         "availableRegions": "us-central1,us-east2"
+                #       }
+                #     }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain
+                  # is typically the registered service name of the tool or product that
+                  # generates the error. Example: "pubsub.googleapis.com". If the error is
+                  # generated by some common infrastructure, the error domain must be a
+                  # globally unique value that identifies the infrastructure. For Google API
+                  # infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error.
+                  #
+                  # Keys must match a regular expression of `a-z+` but should
+                  # ideally be lowerCamelCase. Also, they must be limited to 64 characters in
+                  # length. When identifying the current value of an exceeded limit, the units
+                  # should be contained in the key, not the value.  For example, rather than
+                  # `{"instanceLimit": "100/request"}`, should be returned as,
+                  # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of
+                  # instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the
+                  # proximate cause of the error. Error reasons are unique within a particular
+                  # domain of errors. This should be at most 63 characters and match a
+                  # regular expression of `A-Z+[A-Z0-9]`, which represents
+                  # UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action.
+                #
+                # For example, if a quota check failed with an error indicating the calling
+                # project hasn't enabled the accessed service, this can contain a URL pointing
+                # directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user
+                # which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at
+                  # https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
+                  # Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota
+                  #  type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type
+                  # or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error.
+            # This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "getVersionOperationMetadata": {
+    "inlineSbomInfo": {
+      "currentComponentVersions": { # A mapping of components to their currently-applied versions or other
+          # appropriate identifiers.
+        "a_key": "A String",
+      },
+      "targetComponentVersions": { # A mapping of components to their target versions or other appropriate
+          # identifiers.
+        "a_key": "A String",
+      },
     },
-  ],
-  "name": "A String", # Name of the resource. Provided by the client when the resource is created.
-      # The name must be 1-63 characters long, and comply withRFC1035.
-      # Specifically, the name must be 1-63 characters long and match the regular
-      # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
-      # character must be a lowercase letter, and all following characters must
-      # be a dash, lowercase letter, or digit, except the last character, which
-      # cannot be a dash.
-  "nats": [ # A list of NAT services created in this router.
-    { # Represents a Nat resource. It enables the VMs within the specified
-        # subnetworks to access Internet without external IP addresses. It specifies
-        # a list of subnetworks (and the ranges within) that want to use NAT.
-        # Customers can also provide the external IPs that would be used for NAT. GCP
-        # would auto-allocate ephemeral IPs if no external IPs are provided.
-      "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses.
-          # Must be one of: PREMIUM, STANDARD.
-          # If not specified, then the current
-          # project-level default tier is used.
-      "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs
-          # must be valid static external IPs that have been assigned to the NAT.
-          # These IPs should be used for updating/patching a NAT only.
-        "A String",
-      ],
-      "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT
-          # state. This value is equal to tcp_time_wait_timeout_sec.
-          # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or
-          # 120s. The field is output only.
-      "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation.
-          #
-          #
-          # If not specified, it is disabled by default.
-          #
-          #
-          # If set to true,
-          #
-          #    - Dynamic Port Allocation will be enabled on this NAT
-          #    config.
-          #    - enableEndpointIndependentMapping cannot be set to true.
-          #    - If minPorts is set, minPortsPerVm must be set to a
-          #    power of two greater than or equal to 32. If minPortsPerVm is not set, a
-          #    minimum of 32 ports will be allocated to a VM from this NAT
-          #    config.
-      "enableEndpointIndependentMapping": True or False,
-      "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list
-          # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM
-        "A String",
-      ],
-      "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
-      "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT.
-        "enable": True or False, # Indicates whether or not to export logs. This is false by default.
-        "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified,
-            # logs are exported for all connections handled by this NAT.
-            # This option can take one of the following values:
-            #
-            #    - ERRORS_ONLY: Export logs only for connection failures.
-            #    - TRANSLATIONS_ONLY: Export logs only for successful
-            #    connections.
-            #    - ALL: Export logs for all connections, successful and
-            #    unsuccessful.
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error
+      # message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error
+      # status code that was returned. For example, a `404` means the
+      # resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is
+      # defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested.
+      # This value is inRFC3339
+      # text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an
+            # error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information
+            # if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
       },
-      "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when
-          # Dynamic Port Allocation is enabled.
-          #
-          #
-          # If Dynamic Port Allocation is not enabled, this field has no effect.
-          #
-          #
-          # If Dynamic Port Allocation is enabled, and this field is set, it must be
-          # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm
-          # is not set.
-          #
-          #
-          # If Dynamic Port Allocation is enabled and this field is not set,
-          # a maximum of 65536 ports will be allocated to a VM from this NAT
-          # config.
-      "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not
-          # set, a default number of ports is allocated to a VM. This is rounded
-          # up to the nearest power of 2. For example, if the value of this field is
-          # 50, at least 64 ports are allocated to a VM.
-      "name": "A String", # Unique name of this Nat service.
-          # The name must be 1-63 characters long and comply withRFC1035.
-      "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64
-          # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is
-          # selected for the SubnetworkIpRangeToNat64Option above.
-        { # Specifies a subnetwork to enable NAT64.
-          "name": "A String", # URL for the subnetwork resource that will use NAT64.
-        },
-      ],
-      "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following
-          # values:
-          #
-          #    - MANUAL_ONLY: Uses only Nat IP addresses provided by
-          #    customers. When there are not enough specified Nat IPs, the Nat service
-          #    fails for new VMs.
-          #    - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers
-          #    can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should
-          #    be empty.
-      "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP
-          # addresses must be valid static external IP addresses assigned to the
-          # project.
-        "A String",
-      ],
-      "rules": [ # A list of rules associated with this NAT.
-        {
-          "action": { # The action to be enforced for traffic that matches this rule.
-            "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP
-                # addresses must be valid static external IP addresses assigned to the
-                # project.
-                # This field is used for public NAT.
-              "A String",
-            ],
-            "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this
-                # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.
-                # This field is used for private NAT.
-              "A String",
-            ],
-            "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs
-                # must be valid static external IPs that have been assigned to the NAT.
-                # These IPs should be used for updating/patching a NAT rule only.
-                # This field is used for public NAT.
-              "A String",
-            ],
-            "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be
-                # drained. This is only supported on patch/update, and these
-                # subnetworks must have previously been used as active ranges in this
-                # NAT Rule.
-                # This field is used for private NAT.
-              "A String",
-            ],
-          },
-          "description": "A String", # An optional description of this rule.
-          "match": "A String", # CEL expression that specifies the match condition that egress traffic
-              # from a VM is evaluated against. If it evaluates to true, the
-              # corresponding `action` is enforced.
-              #
-              # The following examples are valid match expressions for public NAT:
-              #
-              # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,
-              #      '2.2.0.0/16')`
-              #
-              # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`
-              #
-              # The following example is a valid match expression for private NAT:
-              #
-              # `nexthop.hub ==
-              # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`
-          "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number
-              # must be a positive value between 0 and 65000, and
-              # must be unique among rules within a NAT.
+    },
+  },
+  "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for
+      # Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a
+      # group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`,
+      # `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
+      # There is no requirement that this be linear or support any granularity of
+      # operations. This should not be used to guess when the operation will be
+      # complete. This number should monotonically increase as the operation
+      # progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only
+      # applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
+      # this field will contain information on all underlying zonal actions and
+      # their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key).
+        # Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
+            # populated.
+            # 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).
+          "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.
         },
-      ],
-      "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values:
-          #
-          #    - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every
-          #    Subnetwork are allowed to Nat.
-          #    - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges
-          #    in every Subnetwork are allowed to Nat.
-          #    - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat
-          #    (specified in the field subnetwork below)
-          #
-          #
-          # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.
-          # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there
-          # should not be any other Router.Nat section in any Router for this network
-          # in this region.
-      "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following
-          # values:
-          #
-          #    - ALL_IPV6_SUBNETWORKS: All of the IP ranges in
-          #    every Subnetwork are allowed to Nat.
-          #    - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat
-          #    (specified in the field nat64_subnetwork below)
-          #
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following:
+            # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server.
+      # This value is inRFC3339
+      # text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the
+      # following:
+      # `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the
+      # operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation
+      # of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For
+      # operations related to creating a snapshot, this points to the disk
+      # that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example:
+      # `user@example.com` or
+      # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the
+      # operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute
+          # Engine returns NO_RESULTS_ON_PAGE if there
+          # are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key:
+          # value format. For example:
           #
-          # The default is NAT64_OPTION_UNSPECIFIED.
-          # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other
-          # Router.Nat section in this region can also enable NAT64 for any
-          # Subnetworks in this network. Other Router.Nat sections can still be
-          # present to enable NAT44 only.
-      "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT
-          # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
-          # SubnetworkIpRangeToNatOption above.
-        { # Defines the IP ranges that want to use NAT for a subnetwork.
-          "name": "A String", # URL for the subnetwork resource that will use NAT.
-          "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to
-              # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES"
-              # is one of the values in source_ip_ranges_to_nat.
-            "A String",
-          ],
-          "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All
-              # options of a single value are valid except
-              # NAT_IP_RANGE_OPTION_UNSPECIFIED.
-              # The only valid option with multiple values is: ["PRIMARY_IP_RANGE",
-              # "LIST_OF_SECONDARY_IP_RANGES"]
-              # Default: [ALL_IP_RANGES]
-            "A String",
-          ],
+          # "data": [
+          #   {
+          #    "key": "scope",
+          #    "value": "zones/us-east1-d"
+          #   }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being
+              # returned. For example, for warnings where there are no results in a list
+              # request for a particular zone, this key might be scope and
+              # the key value might be the zone name. Other examples might be a key
+              # indicating a deprecated resource and a suggested replacement, or a
+              # warning about invalid network settings (for example, if an instance
+              # attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
         },
       ],
-      "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s
-          # if not set.
-      "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state.
-          # Defaults to 120s if not set.
-      "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if
-          # not set.
-      "type": "A String", # Indicates whether this NAT is used for public or private IP
-          # translation. If unspecified, it defaults to PUBLIC.
-      "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
     },
   ],
-  "nccGateway": "A String", # URI of the ncc_gateway to which this router associated.
-  "network": "A String", # URI of the network to which this router belongs.
-  "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted
-      # as part of resource payload.
-    "resourceManagerTags": { # Tag keys/values directly bound to this resource.
-        # The field is allowed for INSERT
-        # only. The keys/values to set on the resource should be specified in
-        # either ID { : } or Namespaced format
-        # { : }.
-        # For example the following are valid inputs:
-        # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"}
-        # * {"123/environment" : "production", "345/abc" : "xyz"}
-        # Note:
-        # * Invalid combinations of ID & namespaced format is not supported. For
-        #   instance: {"123/environment" : "tagValues/444"} is invalid.
-        # * Inconsistent format is not supported. For instance:
-        #   {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid.
-      "a_key": "A String",
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only
+      # applicable when performing per-zone operations.
+}
+
+ +
+ patchNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None) +
Patches Named Set
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource where Named Set is defined. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "description": "A String", # An optional description of named set.
+  "elements": [ # CEL expressions that are comparable to constructs of this set's type
+      # (see Policy Language).
+    { # Represents a textual expression in the Common Expression Language (CEL)
+        # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+        # are documented at https://github.com/google/cel-spec.
+        #
+        # Example (Comparison):
+        #
+        #     title: "Summary size limit"
+        #     description: "Determines if a summary is less than 100 chars"
+        #     expression: "document.summary.size() < 100"
+        #
+        # Example (Equality):
+        #
+        #     title: "Requestor is owner"
+        #     description: "Determines if requestor is the document owner"
+        #     expression: "document.owner == request.auth.claims.email"
+        #
+        # Example (Logic):
+        #
+        #     title: "Public documents"
+        #     description: "Determine whether the document should be publicly visible"
+        #     expression: "document.type != 'private' && document.type != 'internal'"
+        #
+        # Example (Data Manipulation):
+        #
+        #     title: "Notification string"
+        #     description: "Create a notification string with a timestamp."
+        #     expression: "'New message received at ' + string(document.create_time)"
+        #
+        # The exact variables and functions that may be referenced within an expression
+        # are determined by the service that evaluates it. See the service
+        # documentation for additional information.
+      "description": "A String", # Optional. Description of the expression. This is a longer text which
+          # describes the expression, e.g. when hovered over it in a UI.
+      "expression": "A String", # Textual representation of an expression in Common Expression Language
+          # syntax.
+      "location": "A String", # Optional. String indicating the location of the expression for error
+          # reporting, e.g. a file name and a position in the file.
+      "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+          # its purpose. This can be used e.g. in UIs which allow to enter the
+          # expression.
     },
-  },
-  "region": "A String", # [Output Only] URI of the region where the router resides.
-      # You must specify this field as part of the HTTP request URL. It is
-      # not settable as a field in the request body.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  ],
+  "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is
+      # essentially a hash of the Named Set used for optimistic locking.
+      # The fingerprint is initially generated by Compute Engine and changes
+      # after every request to modify or update the Named Set. You must always
+      # provide an up-to-date fingerprint hash in order to update or change
+      # labels.
+      # 
+      # To see the latest fingerprint, make a getNamedSet() request
+      # to retrieve a Named Set.
+  "name": "A String", # This set's name, which must be a resource ID segment and unique within all
+      # named sets owned by the Router. Name should conform to RFC1035.
+  "type": "A String", # This named set's type
 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
@@ -7357,463 +8325,819 @@ 

Method Details

# establish BGP peering. This information must specify the peer ASN and # either the interface name, IP address, or peer IP address. Please refer toRFC4273. { - "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. - "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, - # which currently supports the following option: + "advertiseMode": "A String", # User-specified flag to indicate which mode to use for advertisement. + "advertisedGroups": [ # User-specified list of prefix groups to advertise in custom mode, + # which currently supports the following option: + # + # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This + # excludes any routes learned for subnets that use + # VPC Network Peering. + # + # + # Note that this field can only be populated if advertise_mode is CUSTOM + # and overrides the list defined for the router (in the "bgp" message). + # These groups are advertised in addition to any specified prefixes. + # Leave this field blank to advertise no custom groups. + "A String", + ], + "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. + # This field can only be populated if advertise_mode is CUSTOM and + # overrides the list defined for the router (in the "bgp" message). + # These IP ranges are advertised in addition to any specified groups. + # Leave this field blank to advertise no custom IP ranges. + { # Description-tagged IP ranges for the router to advertise. + "description": "A String", # User-specified description for the IP range. + "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. + }, + ], + "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more + # than one matching route of maximum length, the routes with the lowest + # priority value win. + "bfd": { # BFD configuration for the BGP peering. + "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets + # received from the peer router. The actual value is negotiated between + # the two routers and is equal to the greater of this value and the + # transmit interval of the other router. + # + # + # If set, this value must be between 1000 and 30000. + # + # + # The default is 1000. + "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets + # transmitted to the peer router. The actual value is negotiated between + # the two routers and is equal to the greater of this value and the + # corresponding receive interval of the other router. + # + # + # If set, this value must be between 1000 and 30000. + # + # + # The default is 1000. + "multiplier": 42, # The number of consecutive BFD packets that must be missed + # before BFD declares that a peer is unavailable. + # + # + # If set, the value must be a value between 5 and 16. + # + # + # The default is 5. + "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. + # + # + # If set to ACTIVE, the Cloud Router will initiate the BFD session for + # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the + # peer router to initiate the BFD session for this BGP peer. If set to + # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. + }, + "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP + # session. + { + "range": "A String", # The custom learned route IP address range. Must be a valid + # CIDR-formatted prefix. If an IP address is provided without a subnet + # mask, it is interpreted as, for IPv4, a `/32` singular IP address + # range, and, for IPv6, `/128`. + }, + ], + "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This + # value is applied to all custom learned route ranges for the session. + # You can choose a value from `0` to `65335`. If you don't provide a + # value, Google Cloud assigns a priority of `100` to the ranges. + "enable": "A String", # The status of the BGP peer connection. + # + # + # If set to FALSE, any active session with the peer is terminated and + # all associated routing information is removed. If set to TRUE, the + # peer connection can be established with routing information. The default + # is TRUE. + "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if + # the peerIpAddress is version 4. + "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the + # peerIpAddress is version 6. + "exportPolicies": [ # List of export policies applied to this peer, in the order they must be + # evaluated. The name must correspond to an existing policy that has + # ROUTE_POLICY_TYPE_EXPORT type. + "A String", + ], + "importPolicies": [ # List of import policies applied to this peer, in the order they must be + # evaluated. The name must correspond to an existing policy that has + # ROUTE_POLICY_TYPE_IMPORT type. + "A String", + ], + "interfaceName": "A String", # Name of the interface the BGP peer is associated with. + "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. + "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. + "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. + "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. + # + # - MANAGED_BY_USER is the default value and can be managed by you + # or other users + # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed + # by Cloud Interconnect, specifically by an InterconnectAttachment of type + # PARTNER. Google automatically creates, updates, and deletes this type of + # BGP peer when the PARTNER InterconnectAttachment is created, updated, + # or deleted. + "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the + # name of one of the entries in the Router.md5_authentication_keys. The + # field must comply with RFC1035. + "name": "A String", # Name of this BGP peer. + # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 + # characters long and match the regular expression + # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a + # lowercase letter, and all following characters must be a dash, lowercase + # letter, or digit, except the last character, which cannot be a dash. + "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use + # a different value. + "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. + "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. + "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. + "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router + # appliances such as Next Gen Firewalls, Virtual Routers, or Router + # Appliances. The VM instance must be located in zones contained in the + # same region as this Cloud Router. + # The VM instance is the peer side of the BGP session. + }, + ], + "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 + # text format. + "description": "A String", # An optional description of this resource. Provide this property when you + # create the resource. + "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN + # attachments (interconnectAttachments). + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is + # defined by the server. + "interfaces": [ # Router interfaces. + # To create a BGP peer that uses a router interface, + # the interface must have one of the following fields specified: + # + # - linkedVpnTunnel + # - linkedInterconnectAttachment + # - subnetwork + # + # + # You can create a router interface without any of these fields specified. + # However, you cannot create a BGP peer that uses that interface. + { + "ipRange": "A String", # IP address and range of the interface. # - # - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This - # excludes any routes learned for subnets that use - # VPC Network Peering. + # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must + # be a CIDR-formatted string, for example, 169.254.0.1/30. + # Note: Do not truncate the IP address, as it represents the IP address of + # the interface. + # - For Internet Protocol version 6 (IPv6), the value + # must be a unique local address (ULA) range from fdff:1::/64 + # with a mask length of 126 or less. This value should be a CIDR-formatted + # string, for example, fdff:1::1/112. Within the router's + # VPC, this IPv6 prefix will be reserved exclusively for this connection + # and cannot be used for any other purpose. + "ipVersion": "A String", # IP version of this interface. + "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region + # as the router. Each interface can have one linked resource, which can be + # a VPN tunnel, an Interconnect attachment, or a subnetwork. + "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the + # router. Each interface can have one linked resource, which can be + # a VPN tunnel, an Interconnect attachment, or a subnetwork. + "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. + # + # - MANAGED_BY_USER is the default value and can be managed directly + # by users. + # - MANAGED_BY_ATTACHMENT is an interface that is configured and + # managed by Cloud Interconnect, specifically, by an InterconnectAttachment + # of type PARTNER. Google automatically creates, updates, and deletes + # this type of interface when the PARTNER InterconnectAttachment is + # created, updated, or deleted. + "name": "A String", # Name of this interface entry. + # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 + # characters long and match the regular expression + # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a + # lowercase letter, and all following characters must be a dash, lowercase + # letter, or digit, except the last character, which cannot be a dash. + "privateIpAddress": "A String", # The regional private internal IP address that is used to establish + # BGP sessions to a VM instance acting as a third-party + # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or + # an SD-WAN VM. + "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface + # you are creating. The redundantInterface must belong to the same Cloud + # Router as the interface here. To establish the BGP session to a Router + # Appliance VM, you must create two BGP peers. The two BGP peers must be + # attached to two separate interfaces that are redundant with each other. + # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must + # be 1-63 characters long and match the regular expression + # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a + # lowercase letter, and all following characters must be a dash, lowercase + # letter, or digit, except the last character, which cannot be a dash. + "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which + # must be in the same region as the Cloud Router. + # When you establish a BGP session to a VM instance using this interface, + # the VM instance must belong to the same subnetwork as the subnetwork + # specified here. + }, + ], + "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for + # routers. + "md5AuthenticationKeys": [ # Keys used for MD5 authentication. + { + "key": "A String", # [Input only] Value of the key. # + # For patch and update calls, it can be skipped to + # copy the value from the previous configuration. This is allowed if the + # key with the same name existed before the operation. Maximum length is 80 + # characters. Can only contain printable ASCII characters. + "name": "A String", # Name used to identify the key. # - # Note that this field can only be populated if advertise_mode is CUSTOM - # and overrides the list defined for the router (in the "bgp" message). - # These groups are advertised in addition to any specified prefixes. - # Leave this field blank to advertise no custom groups. + # Must be unique within a router. Must be referenced by exactly + # one bgpPeer. Must comply withRFC1035. + }, + ], + "name": "A String", # Name of the resource. Provided by the client when the resource is created. + # The name must be 1-63 characters long, and comply withRFC1035. + # Specifically, the name must be 1-63 characters long and match the regular + # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first + # character must be a lowercase letter, and all following characters must + # be a dash, lowercase letter, or digit, except the last character, which + # cannot be a dash. + "nats": [ # A list of NAT services created in this router. + { # Represents a Nat resource. It enables the VMs within the specified + # subnetworks to access Internet without external IP addresses. It specifies + # a list of subnetworks (and the ranges within) that want to use NAT. + # Customers can also provide the external IPs that would be used for NAT. GCP + # would auto-allocate ephemeral IPs if no external IPs are provided. + "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. + # Must be one of: PREMIUM, STANDARD. + # If not specified, then the current + # project-level default tier is used. + "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs + # must be valid static external IPs that have been assigned to the NAT. + # These IPs should be used for updating/patching a NAT only. "A String", ], - "advertisedIpRanges": [ # User-specified list of individual IP ranges to advertise in custom mode. - # This field can only be populated if advertise_mode is CUSTOM and - # overrides the list defined for the router (in the "bgp" message). - # These IP ranges are advertised in addition to any specified groups. - # Leave this field blank to advertise no custom IP ranges. - { # Description-tagged IP ranges for the router to advertise. - "description": "A String", # User-specified description for the IP range. - "range": "A String", # The IP range to advertise. The value must be a CIDR-formatted string. - }, + "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT + # state. This value is equal to tcp_time_wait_timeout_sec. + # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or + # 120s. The field is output only. + "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. + # + # + # If not specified, it is disabled by default. + # + # + # If set to true, + # + # - Dynamic Port Allocation will be enabled on this NAT + # config. + # - enableEndpointIndependentMapping cannot be set to true. + # - If minPorts is set, minPortsPerVm must be set to a + # power of two greater than or equal to 32. If minPortsPerVm is not set, a + # minimum of 32 ports will be allocated to a VM from this NAT + # config. + "enableEndpointIndependentMapping": True or False, + "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list + # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM + "A String", ], - "advertisedRoutePriority": 42, # The priority of routes advertised to this BGP peer. Where there is more - # than one matching route of maximum length, the routes with the lowest - # priority value win. - "bfd": { # BFD configuration for the BGP peering. - "minReceiveInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # received from the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # transmit interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "minTransmitInterval": 42, # The minimum interval, in milliseconds, between BFD control packets - # transmitted to the peer router. The actual value is negotiated between - # the two routers and is equal to the greater of this value and the - # corresponding receive interval of the other router. - # - # - # If set, this value must be between 1000 and 30000. - # - # - # The default is 1000. - "multiplier": 42, # The number of consecutive BFD packets that must be missed - # before BFD declares that a peer is unavailable. - # - # - # If set, the value must be a value between 5 and 16. - # - # - # The default is 5. - "sessionInitializationMode": "A String", # The BFD session initialization mode for this BGP peer. - # + "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. + "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. + "enable": True or False, # Indicates whether or not to export logs. This is false by default. + "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, + # logs are exported for all connections handled by this NAT. + # This option can take one of the following values: # - # If set to ACTIVE, the Cloud Router will initiate the BFD session for - # this BGP peer. If set to PASSIVE, the Cloud Router will wait for the - # peer router to initiate the BFD session for this BGP peer. If set to - # DISABLED, BFD is disabled for this BGP peer. The default is DISABLED. + # - ERRORS_ONLY: Export logs only for connection failures. + # - TRANSLATIONS_ONLY: Export logs only for successful + # connections. + # - ALL: Export logs for all connections, successful and + # unsuccessful. }, - "customLearnedIpRanges": [ # A list of user-defined custom learned route IP address ranges for a BGP - # session. + "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when + # Dynamic Port Allocation is enabled. + # + # + # If Dynamic Port Allocation is not enabled, this field has no effect. + # + # + # If Dynamic Port Allocation is enabled, and this field is set, it must be + # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm + # is not set. + # + # + # If Dynamic Port Allocation is enabled and this field is not set, + # a maximum of 65536 ports will be allocated to a VM from this NAT + # config. + "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not + # set, a default number of ports is allocated to a VM. This is rounded + # up to the nearest power of 2. For example, if the value of this field is + # 50, at least 64 ports are allocated to a VM. + "name": "A String", # Unique name of this Nat service. + # The name must be 1-63 characters long and comply withRFC1035. + "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 + # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is + # selected for the SubnetworkIpRangeToNat64Option above. + { # Specifies a subnetwork to enable NAT64. + "name": "A String", # URL for the subnetwork resource that will use NAT64. + }, + ], + "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following + # values: + # + # - MANUAL_ONLY: Uses only Nat IP addresses provided by + # customers. When there are not enough specified Nat IPs, the Nat service + # fails for new VMs. + # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers + # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should + # be empty. + "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP + # addresses must be valid static external IP addresses assigned to the + # project. + "A String", + ], + "rules": [ # A list of rules associated with this NAT. { - "range": "A String", # The custom learned route IP address range. Must be a valid - # CIDR-formatted prefix. If an IP address is provided without a subnet - # mask, it is interpreted as, for IPv4, a `/32` singular IP address - # range, and, for IPv6, `/128`. + "action": { # The action to be enforced for traffic that matches this rule. + "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP + # addresses must be valid static external IP addresses assigned to the + # project. + # This field is used for public NAT. + "A String", + ], + "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this + # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. + # This field is used for private NAT. + "A String", + ], + "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs + # must be valid static external IPs that have been assigned to the NAT. + # These IPs should be used for updating/patching a NAT rule only. + # This field is used for public NAT. + "A String", + ], + "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be + # drained. This is only supported on patch/update, and these + # subnetworks must have previously been used as active ranges in this + # NAT Rule. + # This field is used for private NAT. + "A String", + ], + }, + "description": "A String", # An optional description of this rule. + "match": "A String", # CEL expression that specifies the match condition that egress traffic + # from a VM is evaluated against. If it evaluates to true, the + # corresponding `action` is enforced. + # + # The following examples are valid match expressions for public NAT: + # + # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, + # '2.2.0.0/16')` + # + # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` + # + # The following example is a valid match expression for private NAT: + # + # `nexthop.hub == + # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` + "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number + # must be a positive value between 0 and 65000, and + # must be unique among rules within a NAT. }, ], - "customLearnedRoutePriority": 42, # The user-defined custom learned route priority for a BGP session. This - # value is applied to all custom learned route ranges for the session. - # You can choose a value from `0` to `65335`. If you don't provide a - # value, Google Cloud assigns a priority of `100` to the ranges. - "enable": "A String", # The status of the BGP peer connection. + "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: # + # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every + # Subnetwork are allowed to Nat. + # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges + # in every Subnetwork are allowed to Nat. + # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat + # (specified in the field subnetwork below) # - # If set to FALSE, any active session with the peer is terminated and - # all associated routing information is removed. If set to TRUE, the - # peer connection can be established with routing information. The default - # is TRUE. - "enableIpv4": True or False, # Enable IPv4 traffic over BGP Peer. It is enabled by default if - # the peerIpAddress is version 4. - "enableIpv6": True or False, # Enable IPv6 traffic over BGP Peer. It is enabled by default if the - # peerIpAddress is version 6. - "exportPolicies": [ # List of export policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_EXPORT type. - "A String", - ], - "importPolicies": [ # List of import policies applied to this peer, in the order they must be - # evaluated. The name must correspond to an existing policy that has - # ROUTE_POLICY_TYPE_IMPORT type. - "A String", - ], - "interfaceName": "A String", # Name of the interface the BGP peer is associated with. - "ipAddress": "A String", # IP address of the interface inside Google Cloud Platform. - "ipv4NexthopAddress": "A String", # IPv4 address of the interface inside Google Cloud Platform. - "ipv6NexthopAddress": "A String", # IPv6 address of the interface inside Google Cloud Platform. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this BGP peer. # - # - MANAGED_BY_USER is the default value and can be managed by you - # or other users - # - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed - # by Cloud Interconnect, specifically by an InterconnectAttachment of type - # PARTNER. Google automatically creates, updates, and deletes this type of - # BGP peer when the PARTNER InterconnectAttachment is created, updated, - # or deleted. - "md5AuthenticationKeyName": "A String", # Present if MD5 authentication is enabled for the peering. Must be the - # name of one of the entries in the Router.md5_authentication_keys. The - # field must comply with RFC1035. - "name": "A String", # Name of this BGP peer. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "peerAsn": 42, # Peer BGP Autonomous System Number (ASN). Each BGP interface may use - # a different value. - "peerIpAddress": "A String", # IP address of the BGP interface outside Google Cloud Platform. - "peerIpv4NexthopAddress": "A String", # IPv4 address of the BGP interface outside Google Cloud Platform. - "peerIpv6NexthopAddress": "A String", # IPv6 address of the BGP interface outside Google Cloud Platform. - "routerApplianceInstance": "A String", # URI of the VM instance that is used as third-party router - # appliances such as Next Gen Firewalls, Virtual Routers, or Router - # Appliances. The VM instance must be located in zones contained in the - # same region as this Cloud Router. - # The VM instance is the peer side of the BGP session. + # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. + # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there + # should not be any other Router.Nat section in any Router for this network + # in this region. + "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following + # values: + # + # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in + # every Subnetwork are allowed to Nat. + # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat + # (specified in the field nat64_subnetwork below) + # + # + # The default is NAT64_OPTION_UNSPECIFIED. + # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other + # Router.Nat section in this region can also enable NAT64 for any + # Subnetworks in this network. Other Router.Nat sections can still be + # present to enable NAT44 only. + "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT + # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the + # SubnetworkIpRangeToNatOption above. + { # Defines the IP ranges that want to use NAT for a subnetwork. + "name": "A String", # URL for the subnetwork resource that will use NAT. + "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to + # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" + # is one of the values in source_ip_ranges_to_nat. + "A String", + ], + "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All + # options of a single value are valid except + # NAT_IP_RANGE_OPTION_UNSPECIFIED. + # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", + # "LIST_OF_SECONDARY_IP_RANGES"] + # Default: [ALL_IP_RANGES] + "A String", + ], + }, + ], + "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s + # if not set. + "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. + # Defaults to 120s if not set. + "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if + # not set. + "type": "A String", # Indicates whether this NAT is used for public or private IP + # translation. If unspecified, it defaults to PUBLIC. + "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. + }, + ], + "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. + "network": "A String", # URI of the network to which this router belongs. + "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted + # as part of resource payload. + "resourceManagerTags": { # Tag keys/values directly bound to this resource. + # The field is allowed for INSERT + # only. The keys/values to set on the resource should be specified in + # either ID { : } or Namespaced format + # { : }. + # For example the following are valid inputs: + # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} + # * {"123/environment" : "production", "345/abc" : "xyz"} + # Note: + # * Invalid combinations of ID & namespaced format is not supported. For + # instance: {"123/environment" : "tagValues/444"} is invalid. + # * Inconsistent format is not supported. For instance: + # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. + "a_key": "A String", + }, + }, + "region": "A String", # [Output Only] URI of the region where the router resides. + # You must specify this field as part of the HTTP request URL. It is + # not settable as a field in the request body. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. +} + + requestId: string, An optional request ID to identify requests. Specify a unique request ID so +that if you must retry your request, the server will know to ignore the +request if it has already been completed. + +For example, consider a situation where you make an initial request and +the request times out. If you make the request again with the same +request ID, the server can check if original operation with the same +request ID was received, and if so, will ignore the second request. This +prevents clients from accidentally creating duplicate commitments. + +The request ID must be +a valid UUID with the exception that zero UUID is not supported +(00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. + # + # Google Compute Engine has three Operation resources: + # + # * [Global](/compute/docs/reference/rest/v1/globalOperations) + # * [Regional](/compute/docs/reference/rest/v1/regionOperations) + # * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) + # + # You can use an operation resource to manage asynchronous API requests. + # For more information, readHandling + # API responses. + # + # Operations can be global, regional or zonal. + # + # - For global operations, use the `globalOperations` + # resource. + # - For regional operations, use the + # `regionOperations` resource. + # - For zonal operations, use + # the `zoneOperations` resource. + # + # + # + # For more information, read + # Global, Regional, and Zonal Resources. + # + # Note that completed Operation resources have a limited + # retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. + # Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is + # set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is inRFC3339 + # text format. + "error": { # [Output Only] If errors are generated during processing of the operation, + # this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this + # operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error + # details. There is a set of defined message types to use for providing + # details.The syntax depends on the error code. For example, + # QuotaExceededInfo will have details when the error code is + # QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. + # + # Example of an error when contacting the "pubsub.googleapis.com" API when it + # is not enabled: + # + # { "reason": "API_DISABLED" + # "domain": "googleapis.com" + # "metadata": { + # "resource": "projects/123", + # "service": "pubsub.googleapis.com" + # } + # } + # + # This response indicates that the pubsub.googleapis.com API is not enabled. + # + # Example of an error that is returned when attempting to create a Spanner + # instance in a region that is out of stock: + # + # { "reason": "STOCKOUT" + # "domain": "spanner.googleapis.com", + # "metadata": { + # "availableRegions": "us-central1,us-east2" + # } + # } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain + # is typically the registered service name of the tool or product that + # generates the error. Example: "pubsub.googleapis.com". If the error is + # generated by some common infrastructure, the error domain must be a + # globally unique value that identifies the infrastructure. For Google API + # infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. + # + # Keys must match a regular expression of `a-z+` but should + # ideally be lowerCamelCase. Also, they must be limited to 64 characters in + # length. When identifying the current value of an exceeded limit, the units + # should be contained in the key, not the value. For example, rather than + # `{"instanceLimit": "100/request"}`, should be returned as, + # `{"instanceLimitPerRequest": "100"}`, if the client exceeds the number of + # instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the + # proximate cause of the error. Error reasons are unique within a particular + # domain of errors. This should be at most 63 characters and match a + # regular expression of `A-Z+[A-Z0-9]`, which represents + # UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. + # + # For example, if a quota check failed with an error indicating the calling + # project hasn't enabled the accessed service, this can contain a URL pointing + # directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user + # which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at + # https://www.rfc-editor.org/rfc/bcp/bcp47.txt. + # Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota + # type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type + # or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. + # This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "getVersionOperationMetadata": { + "inlineSbomInfo": { + "currentComponentVersions": { # A mapping of components to their currently-applied versions or other + # appropriate identifiers. + "a_key": "A String", + }, + "targetComponentVersions": { # A mapping of components to their target versions or other appropriate + # identifiers. + "a_key": "A String", + }, }, - ], - "creationTimestamp": "A String", # Output only. [Output Only] Creation timestamp inRFC3339 - # text format. - "description": "A String", # An optional description of this resource. Provide this property when you - # create the resource. - "encryptedInterconnectRouter": True or False, # Indicates if a router is dedicated for use with encrypted VLAN - # attachments (interconnectAttachments). - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error + # message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error + # status code that was returned. For example, a `404` means the + # resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is # defined by the server. - "interfaces": [ # Router interfaces. - # To create a BGP peer that uses a router interface, - # the interface must have one of the following fields specified: - # - # - linkedVpnTunnel - # - linkedInterconnectAttachment - # - subnetwork - # - # - # You can create a router interface without any of these fields specified. - # However, you cannot create a BGP peer that uses that interface. - { - "ipRange": "A String", # IP address and range of the interface. - # - # - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must - # be a CIDR-formatted string, for example, 169.254.0.1/30. - # Note: Do not truncate the IP address, as it represents the IP address of - # the interface. - # - For Internet Protocol version 6 (IPv6), the value - # must be a unique local address (ULA) range from fdff:1::/64 - # with a mask length of 126 or less. This value should be a CIDR-formatted - # string, for example, fdff:1::1/112. Within the router's - # VPC, this IPv6 prefix will be reserved exclusively for this connection - # and cannot be used for any other purpose. - "ipVersion": "A String", # IP version of this interface. - "linkedInterconnectAttachment": "A String", # URI of the linked Interconnect attachment. It must be in the same region - # as the router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "linkedVpnTunnel": "A String", # URI of the linked VPN tunnel, which must be in the same region as the - # router. Each interface can have one linked resource, which can be - # a VPN tunnel, an Interconnect attachment, or a subnetwork. - "managementType": "A String", # Output only. [Output Only] The resource that configures and manages this interface. - # - # - MANAGED_BY_USER is the default value and can be managed directly - # by users. - # - MANAGED_BY_ATTACHMENT is an interface that is configured and - # managed by Cloud Interconnect, specifically, by an InterconnectAttachment - # of type PARTNER. Google automatically creates, updates, and deletes - # this type of interface when the PARTNER InterconnectAttachment is - # created, updated, or deleted. - "name": "A String", # Name of this interface entry. - # The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 - # characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "privateIpAddress": "A String", # The regional private internal IP address that is used to establish - # BGP sessions to a VM instance acting as a third-party - # Router Appliance, such as a Next Gen Firewall, a Virtual Router, or - # an SD-WAN VM. - "redundantInterface": "A String", # Name of the interface that will be redundant with the current interface - # you are creating. The redundantInterface must belong to the same Cloud - # Router as the interface here. To establish the BGP session to a Router - # Appliance VM, you must create two BGP peers. The two BGP peers must be - # attached to two separate interfaces that are redundant with each other. - # The redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must - # be 1-63 characters long and match the regular expression - # `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a - # lowercase letter, and all following characters must be a dash, lowercase - # letter, or digit, except the last character, which cannot be a dash. - "subnetwork": "A String", # The URI of the subnetwork resource that this interface belongs to, which - # must be in the same region as the Cloud Router. - # When you establish a BGP session to a VM instance using this interface, - # the VM instance must belong to the same subnetwork as the subnetwork - # specified here. - }, - ], - "kind": "compute#router", # Output only. [Output Only] Type of resource. Always compute#router for - # routers. - "md5AuthenticationKeys": [ # Keys used for MD5 authentication. - { - "key": "A String", # [Input only] Value of the key. - # - # For patch and update calls, it can be skipped to - # copy the value from the previous configuration. This is allowed if the - # key with the same name existed before the operation. Maximum length is 80 - # characters. Can only contain printable ASCII characters. - "name": "A String", # Name used to identify the key. - # - # Must be unique within a router. Must be referenced by exactly - # one bgpPeer. Must comply withRFC1035. + "insertTime": "A String", # [Output Only] The time that this operation was requested. + # This value is inRFC3339 + # text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an + # error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information + # if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, }, - ], - "name": "A String", # Name of the resource. Provided by the client when the resource is created. - # The name must be 1-63 characters long, and comply withRFC1035. - # Specifically, the name must be 1-63 characters long and match the regular - # expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first - # character must be a lowercase letter, and all following characters must - # be a dash, lowercase letter, or digit, except the last character, which - # cannot be a dash. - "nats": [ # A list of NAT services created in this router. - { # Represents a Nat resource. It enables the VMs within the specified - # subnetworks to access Internet without external IP addresses. It specifies - # a list of subnetworks (and the ranges within) that want to use NAT. - # Customers can also provide the external IPs that would be used for NAT. GCP - # would auto-allocate ephemeral IPs if no external IPs are provided. - "autoNetworkTier": "A String", # The network tier to use when automatically reserving NAT IP addresses. - # Must be one of: PREMIUM, STANDARD. - # If not specified, then the current - # project-level default tier is used. - "drainNatIps": [ # A list of URLs of the IP resources to be drained. These IPs - # must be valid static external IPs that have been assigned to the NAT. - # These IPs should be used for updating/patching a NAT only. - "A String", - ], - "effectiveTcpTimeWaitTimeoutSec": 42, # Output only. Effective timeout (in seconds) for TCP connections that are in TIME_WAIT - # state. This value is equal to tcp_time_wait_timeout_sec. - # If tcp_time_wait_timeout_sec isn't set, the effective timeout is 30s or - # 120s. The field is output only. - "enableDynamicPortAllocation": True or False, # Enable Dynamic Port Allocation. - # - # - # If not specified, it is disabled by default. - # - # - # If set to true, - # - # - Dynamic Port Allocation will be enabled on this NAT - # config. - # - enableEndpointIndependentMapping cannot be set to true. - # - If minPorts is set, minPortsPerVm must be set to a - # power of two greater than or equal to 32. If minPortsPerVm is not set, a - # minimum of 32 ports will be allocated to a VM from this NAT - # config. - "enableEndpointIndependentMapping": True or False, - "endpointTypes": [ # List of NAT-ted endpoint types supported by the Nat Gateway. If the list - # is empty, then it will be equivalent to include ENDPOINT_TYPE_VM - "A String", - ], - "icmpIdleTimeoutSec": 42, # Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. - "logConfig": { # Configuration of logging on a NAT. # Configure logging on this NAT. - "enable": True or False, # Indicates whether or not to export logs. This is false by default. - "filter": "A String", # Specify the desired filtering of logs on this NAT. If unspecified, - # logs are exported for all connections handled by this NAT. - # This option can take one of the following values: + }, + "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for + # Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a + # group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, + # `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. + # There is no requirement that this be linear or support any granularity of + # operations. This should not be used to guess when the operation will be + # complete. This number should monotonically increase as the operation + # progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only + # applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata, + # this field will contain information on all underlying zonal actions and + # their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). + # Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is + # populated. + # 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. # - # - ERRORS_ONLY: Export logs only for connection failures. - # - TRANSLATIONS_ONLY: Export logs only for successful - # connections. - # - ALL: Export logs for all connections, successful and - # unsuccessful. - }, - "maxPortsPerVm": 42, # Maximum number of ports allocated to a VM from this NAT config when - # Dynamic Port Allocation is enabled. - # - # - # If Dynamic Port Allocation is not enabled, this field has no effect. - # - # - # If Dynamic Port Allocation is enabled, and this field is set, it must be - # set to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm - # is not set. - # - # - # If Dynamic Port Allocation is enabled and this field is not set, - # a maximum of 65536 ports will be allocated to a VM from this NAT - # config. - "minPortsPerVm": 42, # Minimum number of ports allocated to a VM from this NAT config. If not - # set, a default number of ports is allocated to a VM. This is rounded - # up to the nearest power of 2. For example, if the value of this field is - # 50, at least 64 ports are allocated to a VM. - "name": "A String", # Unique name of this Nat service. - # The name must be 1-63 characters long and comply withRFC1035. - "nat64Subnetworks": [ # List of Subnetwork resources whose traffic should be translated by NAT64 - # Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is - # selected for the SubnetworkIpRangeToNat64Option above. - { # Specifies a subnetwork to enable NAT64. - "name": "A String", # URL for the subnetwork resource that will use NAT64. + # 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). + "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. }, - ], - "natIpAllocateOption": "A String", # Specify the NatIpAllocateOption, which can take one of the following - # values: + "state": "A String", # [Output Only] Status of the action, which can be one of the following: + # `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. + # This value is inRFC3339 + # text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the + # following: + # `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the + # operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation + # of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For + # operations related to creating a snapshot, this points to the disk + # that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: + # `user@example.com` or + # `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the + # operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute + # Engine returns NO_RESULTS_ON_PAGE if there + # are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: + # value format. For example: # - # - MANUAL_ONLY: Uses only Nat IP addresses provided by - # customers. When there are not enough specified Nat IPs, the Nat service - # fails for new VMs. - # - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers - # can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should - # be empty. - "natIps": [ # A list of URLs of the IP resources used for this Nat service. These IP - # addresses must be valid static external IP addresses assigned to the - # project. - "A String", - ], - "rules": [ # A list of rules associated with this NAT. + # "data": [ + # { + # "key": "scope", + # "value": "zones/us-east1-d" + # } { - "action": { # The action to be enforced for traffic that matches this rule. - "sourceNatActiveIps": [ # A list of URLs of the IP resources used for this NAT rule. These IP - # addresses must be valid static external IP addresses assigned to the - # project. - # This field is used for public NAT. - "A String", - ], - "sourceNatActiveRanges": [ # A list of URLs of the subnetworks used as source ranges for this - # NAT Rule. These subnetworks must have purpose set to PRIVATE_NAT. - # This field is used for private NAT. - "A String", - ], - "sourceNatDrainIps": [ # A list of URLs of the IP resources to be drained. These IPs - # must be valid static external IPs that have been assigned to the NAT. - # These IPs should be used for updating/patching a NAT rule only. - # This field is used for public NAT. - "A String", - ], - "sourceNatDrainRanges": [ # A list of URLs of subnetworks representing source ranges to be - # drained. This is only supported on patch/update, and these - # subnetworks must have previously been used as active ranges in this - # NAT Rule. - # This field is used for private NAT. - "A String", - ], - }, - "description": "A String", # An optional description of this rule. - "match": "A String", # CEL expression that specifies the match condition that egress traffic - # from a VM is evaluated against. If it evaluates to true, the - # corresponding `action` is enforced. - # - # The following examples are valid match expressions for public NAT: - # - # `inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip, - # '2.2.0.0/16')` - # - # `destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'` - # - # The following example is a valid match expression for private NAT: - # - # `nexthop.hub == - # '//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'` - "ruleNumber": 42, # An integer uniquely identifying a rule in the list. The rule number - # must be a positive value between 0 and 65000, and - # must be unique among rules within a NAT. - }, - ], - "sourceSubnetworkIpRangesToNat": "A String", # Specify the Nat option, which can take one of the following values: - # - # - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every - # Subnetwork are allowed to Nat. - # - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges - # in every Subnetwork are allowed to Nat. - # - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat - # (specified in the field subnetwork below) - # - # - # The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. - # Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there - # should not be any other Router.Nat section in any Router for this network - # in this region. - "sourceSubnetworkIpRangesToNat64": "A String", # Specify the Nat option for NAT64, which can take one of the following - # values: - # - # - ALL_IPV6_SUBNETWORKS: All of the IP ranges in - # every Subnetwork are allowed to Nat. - # - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat - # (specified in the field nat64_subnetwork below) - # - # - # The default is NAT64_OPTION_UNSPECIFIED. - # Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other - # Router.Nat section in this region can also enable NAT64 for any - # Subnetworks in this network. Other Router.Nat sections can still be - # present to enable NAT44 only. - "subnetworks": [ # A list of Subnetwork resources whose traffic should be translated by NAT - # Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the - # SubnetworkIpRangeToNatOption above. - { # Defines the IP ranges that want to use NAT for a subnetwork. - "name": "A String", # URL for the subnetwork resource that will use NAT. - "secondaryIpRangeNames": [ # A list of the secondary ranges of the Subnetwork that are allowed to - # use NAT. This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" - # is one of the values in source_ip_ranges_to_nat. - "A String", - ], - "sourceIpRangesToNat": [ # Specify the options for NAT ranges in the Subnetwork. All - # options of a single value are valid except - # NAT_IP_RANGE_OPTION_UNSPECIFIED. - # The only valid option with multiple values is: ["PRIMARY_IP_RANGE", - # "LIST_OF_SECONDARY_IP_RANGES"] - # Default: [ALL_IP_RANGES] - "A String", - ], + "key": "A String", # [Output Only] A key that provides more detail on the warning being + # returned. For example, for warnings where there are no results in a list + # request for a particular zone, this key might be scope and + # the key value might be the zone name. Other examples might be a key + # indicating a deprecated resource and a suggested replacement, or a + # warning about invalid network settings (for example, if an instance + # attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. }, ], - "tcpEstablishedIdleTimeoutSec": 42, # Timeout (in seconds) for TCP established connections. Defaults to 1200s - # if not set. - "tcpTimeWaitTimeoutSec": 42, # Timeout (in seconds) for TCP connections that are in TIME_WAIT state. - # Defaults to 120s if not set. - "tcpTransitoryIdleTimeoutSec": 42, # Timeout (in seconds) for TCP transitory connections. Defaults to 30s if - # not set. - "type": "A String", # Indicates whether this NAT is used for public or private IP - # translation. If unspecified, it defaults to PUBLIC. - "udpIdleTimeoutSec": 42, # Timeout (in seconds) for UDP connections. Defaults to 30s if not set. + "message": "A String", # [Output Only] A human-readable description of the warning code. }, ], - "nccGateway": "A String", # URI of the ncc_gateway to which this router associated. - "network": "A String", # URI of the network to which this router belongs. - "params": { # Additional router parameters. # Input only. [Input Only] Additional params passed with the request, but not persisted - # as part of resource payload. - "resourceManagerTags": { # Tag keys/values directly bound to this resource. - # The field is allowed for INSERT - # only. The keys/values to set on the resource should be specified in - # either ID { : } or Namespaced format - # { : }. - # For example the following are valid inputs: - # * {"tagKeys/333" : "tagValues/444", "tagKeys/123" : "tagValues/456"} - # * {"123/environment" : "production", "345/abc" : "xyz"} - # Note: - # * Invalid combinations of ID & namespaced format is not supported. For - # instance: {"123/environment" : "tagValues/444"} is invalid. - # * Inconsistent format is not supported. For instance: - # {"tagKeys/333" : "tagValues/444", "123/env" : "prod"} is invalid. - "a_key": "A String", + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only + # applicable when performing per-zone operations. +}
+
+ +
+ updateNamedSet(project, region, router, body=None, requestId=None, x__xgafv=None) +
Updates or creates new Named Set
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  router: string, Name of the Router resource where Named Set is defined. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "description": "A String", # An optional description of named set.
+  "elements": [ # CEL expressions that are comparable to constructs of this set's type
+      # (see Policy Language).
+    { # Represents a textual expression in the Common Expression Language (CEL)
+        # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+        # are documented at https://github.com/google/cel-spec.
+        #
+        # Example (Comparison):
+        #
+        #     title: "Summary size limit"
+        #     description: "Determines if a summary is less than 100 chars"
+        #     expression: "document.summary.size() < 100"
+        #
+        # Example (Equality):
+        #
+        #     title: "Requestor is owner"
+        #     description: "Determines if requestor is the document owner"
+        #     expression: "document.owner == request.auth.claims.email"
+        #
+        # Example (Logic):
+        #
+        #     title: "Public documents"
+        #     description: "Determine whether the document should be publicly visible"
+        #     expression: "document.type != 'private' && document.type != 'internal'"
+        #
+        # Example (Data Manipulation):
+        #
+        #     title: "Notification string"
+        #     description: "Create a notification string with a timestamp."
+        #     expression: "'New message received at ' + string(document.create_time)"
+        #
+        # The exact variables and functions that may be referenced within an expression
+        # are determined by the service that evaluates it. See the service
+        # documentation for additional information.
+      "description": "A String", # Optional. Description of the expression. This is a longer text which
+          # describes the expression, e.g. when hovered over it in a UI.
+      "expression": "A String", # Textual representation of an expression in Common Expression Language
+          # syntax.
+      "location": "A String", # Optional. String indicating the location of the expression for error
+          # reporting, e.g. a file name and a position in the file.
+      "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+          # its purpose. This can be used e.g. in UIs which allow to enter the
+          # expression.
     },
-  },
-  "region": "A String", # [Output Only] URI of the region where the router resides.
-      # You must specify this field as part of the HTTP request URL. It is
-      # not settable as a field in the request body.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  ],
+  "fingerprint": "A String", # A fingerprint for the Named Set being applied to this Router, which is
+      # essentially a hash of the Named Set used for optimistic locking.
+      # The fingerprint is initially generated by Compute Engine and changes
+      # after every request to modify or update the Named Set. You must always
+      # provide an up-to-date fingerprint hash in order to update or change
+      # labels.
+      # 
+      # To see the latest fingerprint, make a getNamedSet() request
+      # to retrieve a Named Set.
+  "name": "A String", # This set's name, which must be a resource ID segment and unique within all
+      # named sets owned by the Router. Name should conform to RFC1035.
+  "type": "A String", # This named set's type
 }
 
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so
diff --git a/docs/dyn/compute_v1.subnetworks.html b/docs/dyn/compute_v1.subnetworks.html
index 63c407614b..69c17ea1ff 100644
--- a/docs/dyn/compute_v1.subnetworks.html
+++ b/docs/dyn/compute_v1.subnetworks.html
@@ -429,6 +429,14 @@ 

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -1389,6 +1397,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -2024,6 +2040,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -2673,6 +2697,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. @@ -3217,6 +3249,14 @@

Method Details

# If `ipCollection` field is specified, but ip_cidr_range is not, # the range is auto-allocated from the PDP referenced by the `ipCollection` # field. + "ipCollection": "A String", # Reference to a Public Delegated Prefix (PDP) for BYOIP. + # This field should be specified for configuring BYOGUA internal IPv6 + # secondary range. + # When specified along with the ip_cidr_range, the ip_cidr_range must lie + # within the PDP referenced by the `ipCollection` field. + # When specified without the ip_cidr_range, the range is auto-allocated + # from the PDP referenced by the `ipCollection` field. + "ipVersion": "A String", "rangeName": "A String", # The name associated with this subnetwork secondary range, used when adding # an alias IP/IPv6 range to a VM instance. # The name must be 1-63 characters long, and comply withRFC1035. diff --git a/docs/dyn/compute_v1.targetHttpsProxies.html b/docs/dyn/compute_v1.targetHttpsProxies.html index 85e38c65b9..0f1caa4b71 100644 --- a/docs/dyn/compute_v1.targetHttpsProxies.html +++ b/docs/dyn/compute_v1.targetHttpsProxies.html @@ -3107,8 +3107,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/docs/dyn/compute_v1.targetSslProxies.html b/docs/dyn/compute_v1.targetSslProxies.html index a6add71cda..e039f3d67f 100644 --- a/docs/dyn/compute_v1.targetSslProxies.html +++ b/docs/dyn/compute_v1.targetSslProxies.html @@ -2219,8 +2219,7 @@

Method Details

The object takes the form of: { - "sslPolicy": "A String", # URL of the SSL policy resource. Set this to empty string to clear any - # existing SSL policy associated with the target proxy resource. + "sslPolicy": "A String", } requestId: string, An optional request ID to identify requests. Specify a unique request ID so diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index efa58e3558..ae6f631a58 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -123,6 +123,234 @@ }, "protocol": "rest", "resources": { +"acceleratorPodControllers": { +"methods": { +"delete": { +"description": "Deletes the specified AcceleratorPodController resource.", +"flatPath": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"httpMethod": "DELETE", +"id": "compute.acceleratorPodControllers.delete", +"parameterOrder": [ +"project", +"zone", +"resourceId" +], +"parameters": { +"project": { +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"location": "query", +"type": "string" +}, +"resourceId": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "Gets the specified AcceleratorPodController resource.", +"flatPath": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"httpMethod": "GET", +"id": "compute.acceleratorPodControllers.get", +"parameterOrder": [ +"project", +"zone", +"resourceId" +], +"parameters": { +"project": { +"location": "path", +"required": true, +"type": "string" +}, +"resourceId": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"zone": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"response": { +"$ref": "AcceleratorPodController" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Inserts a new AcceleratorPodController resource.", +"flatPath": "projects/{project}/zones/{zone}/acceleratorPodControllers", +"httpMethod": "POST", +"id": "compute.acceleratorPodControllers.insert", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"location": "query", +"type": "string" +}, +"zone": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/acceleratorPodControllers", +"request": { +"$ref": "AcceleratorPodController" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "Lists the AcceleratorPodController resources in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/acceleratorPodControllers", +"httpMethod": "GET", +"id": "compute.acceleratorPodControllers.list", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"location": "path", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/acceleratorPodControllers", +"response": { +"$ref": "AcceleratorPodControllersListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Patches the specified AcceleratorPodController resource.", +"flatPath": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"httpMethod": "PATCH", +"id": "compute.acceleratorPodControllers.patch", +"parameterOrder": [ +"project", +"zone", +"resourceId" +], +"parameters": { +"project": { +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"location": "query", +"type": "string" +}, +"resourceId": { +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"updateMask": { +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"zone": { +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/acceleratorPodControllers/{resourceId}", +"request": { +"$ref": "AcceleratorPodController" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "acceleratorTypes": { "methods": { "aggregatedList": { @@ -2278,7 +2506,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project.\nBackend services for external and internal passthrough Network Load\nBalancers are not included in the response.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -2800,18 +3028,26 @@ } } }, -"diskSettings": { +"dhcpOptionsConfigs": { "methods": { -"get": { -"description": "Get Zonal Disk Settings.", -"flatPath": "projects/{project}/zones/{zone}/diskSettings", -"httpMethod": "GET", -"id": "compute.diskSettings.get", +"delete": { +"description": "Deletes the specified DhcpOptionsConfig in the given location", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", +"httpMethod": "DELETE", +"id": "compute.dhcpOptionsConfigs.delete", "parameterOrder": [ "project", -"zone" +"region", +"dhcpOptionsConfig" ], "parameters": { +"dhcpOptionsConfig": { +"description": "Name of the DhcpOptionsConfig resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -2819,34 +3055,46 @@ "required": true, "type": "string" }, -"zone": { -"description": "Name of the zone for this request.", +"region": { +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/zones/{zone}/diskSettings", +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", "response": { -"$ref": "DiskSettings" +"$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, -"patch": { -"description": "Patch Zonal Disk Settings", -"flatPath": "projects/{project}/zones/{zone}/diskSettings", -"httpMethod": "PATCH", -"id": "compute.diskSettings.patch", +"get": { +"description": "Returns the specified DhcpOptionsConfig resource in the given location.", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", +"httpMethod": "GET", +"id": "compute.dhcpOptionsConfigs.get", "parameterOrder": [ "project", -"zone" +"region", +"dhcpOptionsConfig" ], "parameters": { +"dhcpOptionsConfig": { +"description": "Name of the DhcpOptionsConfig resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -2854,28 +3102,57 @@ "required": true, "type": "string" }, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", -"location": "query", +"region": { +"description": "Name of the region of this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, "type": "string" +} }, -"updateMask": { -"description": "update_mask indicates fields to be updated as part of this request.", -"format": "google-fieldmask", -"location": "query", +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", +"response": { +"$ref": "DhcpOptionsConfig" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a DhcpOptionsConfig in the specified project in the given location\nusing the parameters that are included in the request.", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs", +"httpMethod": "POST", +"id": "compute.dhcpOptionsConfigs.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, "type": "string" }, -"zone": { -"description": "The name of the zone for this request.", +"region": { +"description": "Name of the region of this request.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" } }, -"path": "projects/{project}/zones/{zone}/diskSettings", +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs", "request": { -"$ref": "DiskSettings" +"$ref": "DhcpOptionsConfig" }, "response": { "$ref": "Operation" @@ -2884,18 +3161,15 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] -} -} }, -"diskTypes": { -"methods": { -"aggregatedList": { -"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", -"flatPath": "projects/{project}/aggregated/diskTypes", +"list": { +"description": "Lists the DhcpOptionsConfigs for a project in the given location.", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs", "httpMethod": "GET", -"id": "compute.diskTypes.aggregatedList", +"id": "compute.dhcpOptionsConfigs.list", "parameterOrder": [ -"project" +"project", +"region" ], "parameters": { "filter": { @@ -2903,11 +3177,266 @@ "location": "query", "type": "string" }, -"includeAllScopes": { -"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", -"location": "query", -"type": "boolean" -}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region of this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs", +"response": { +"$ref": "DhcpOptionsConfigList" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Patches the specified DhcpOptionsConfig resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", +"httpMethod": "PATCH", +"id": "compute.dhcpOptionsConfigs.patch", +"parameterOrder": [ +"project", +"region", +"dhcpOptionsConfig" +], +"parameters": { +"dhcpOptionsConfig": { +"description": "Name of the DhcpOptionsConfig resource to patch.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}", +"request": { +"$ref": "DhcpOptionsConfig" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource.", +"flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions", +"httpMethod": "POST", +"id": "compute.dhcpOptionsConfigs.testIamPermissions", +"parameterOrder": [ +"project", +"region", +"resource" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"resource": { +"description": "Name or id of the resource for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions", +"request": { +"$ref": "TestPermissionsRequest" +}, +"response": { +"$ref": "TestPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, +"diskSettings": { +"methods": { +"get": { +"description": "Get Zonal Disk Settings.", +"flatPath": "projects/{project}/zones/{zone}/diskSettings", +"httpMethod": "GET", +"id": "compute.diskSettings.get", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/diskSettings", +"response": { +"$ref": "DiskSettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"patch": { +"description": "Patch Zonal Disk Settings", +"flatPath": "projects/{project}/zones/{zone}/diskSettings", +"httpMethod": "PATCH", +"id": "compute.diskSettings.patch", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "update_mask indicates fields to be updated as part of this request.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/diskSettings", +"request": { +"$ref": "DiskSettings" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, +"diskTypes": { +"methods": { +"aggregatedList": { +"description": "Retrieves an aggregated list of disk types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.", +"flatPath": "projects/{project}/aggregated/diskTypes", +"httpMethod": "GET", +"id": "compute.diskTypes.aggregatedList", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"includeAllScopes": { +"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.", +"location": "query", +"type": "boolean" +}, "maxResults": { "default": "500", "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", @@ -30235,7 +30764,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project in\nthe given region.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project in the\ngiven region. Backend services for external and internal passthrough\nNetwork Load Balancers are not included in the response.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -57095,7 +57624,7 @@ } } }, -"revision": "20260625", +"revision": "20260629", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -57137,169 +57666,369 @@ }, "type": "object" }, -"AcceleratorTopologiesInfo": { -"description": "Info for accelerator topologies within a densely packed reservation.", -"id": "AcceleratorTopologiesInfo", -"properties": { -"acceleratorTopologyInfos": { -"description": "Info for each accelerator topology.", -"items": { -"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo" -}, -"type": "array" -} -}, -"type": "object" -}, -"AcceleratorTopologiesInfoAcceleratorTopologyInfo": { -"description": "Info for a slice of a given topology.", -"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo", -"properties": { -"acceleratorTopology": { -"description": "The accelerator topology.", -"type": "string" -}, -"infoPerTopologyStates": { -"description": "Info for each topology state.", -"items": { -"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState" -}, -"type": "array" -} -}, -"type": "object" -}, -"AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": { -"description": "Info for each topology state.", -"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState", -"properties": { -"count": { -"description": "The number of accelerator topologies in this state.", -"format": "int32", -"type": "integer" -}, -"state": { -"description": "The state of the accelerator topology.", -"enum": [ -"AVAILABLE", -"DEGRADED", -"RUNNING", -"TOPOLOGY_STATE_UNSPECIFIED", -"UNHEALTHY" -], -"enumDeprecated": [ -false, -false, -false, -false, -true -], -"enumDescriptions": [ -"The accelerator topology is available.", -"The accelerator topology is degraded. The underlying capacity is not in a\nhealthy state and is not available.", -"The accelerator topology is running. If there are both running and\ndegraded hosts within a topology, DEGRADED state will be returned.", -"The state of the topology is unspecified.", -"This value has been deprecated and is no longer used." -], -"type": "string" -} -}, -"type": "object" -}, -"AcceleratorType": { -"description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.", -"id": "AcceleratorType", +"AcceleratorPodController": { +"description": "Represents a controller for managing out-of-band access to an accelerator\ndomain (e.g., NVLink Domain).", +"id": "AcceleratorPodController", "properties": { "creationTimestamp": { -"description": "[Output Only] Creation timestamp inRFC3339 text format.", +"description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.", +"readOnly": true, "type": "string" }, -"deprecated": { -"$ref": "DeprecationStatus", -"description": "[Output Only] The deprecation status associated with this accelerator type." -}, "description": { -"description": "[Output Only] An optional textual description of the resource.", +"description": "An optional description of this resource.", "type": "string" }, "id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", "format": "uint64", +"readOnly": true, "type": "string" }, "kind": { -"default": "compute#acceleratorType", -"description": "Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types.", "readOnly": true, "type": "string" }, -"maximumCardsPerInstance": { -"description": "[Output Only] Maximum number of accelerator cards allowed per instance.", -"format": "int32", -"type": "integer" +"managementInterfaces": { +"additionalProperties": { +"$ref": "ManagementInterface" +}, +"description": "Map of management interfaces. Keys must be valid RFC1035 names and at most\n63 characters long.", +"type": "object" }, "name": { -"description": "[Output Only] Name of the resource.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"description": "Required. The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash, lowercase\nletter, or digit, except the last character, which cannot be a dash.", "type": "string" }, "selfLink": { -"description": "Output only. [Output Only] Server-defined, fully qualified URL for this resource.", +"description": "Output only. [Output Only] Server-defined URL for the resource.", "readOnly": true, "type": "string" }, "selfLinkWithId": { -"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.", +"description": "Output only. [Output Only] Server-defined URL for the resource with the resource ID.", "readOnly": true, "type": "string" }, +"target": { +"description": "Required. The target accelerator domain this controller manages.\nThis must be a resolvable identifier for the specific NVLink Domain or\nTPU system (e.g., a Reservation Sub-block URI).\nExample:\n\"projects/my-project/reservations/my-reservation/subBlocks/subblock-1\".", +"type": "string" +}, "zone": { -"description": "[Output Only] The name of the zone where the accelerator type resides,\nsuch as us-central1-a.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"description": "Output only. [Output Only] URL of the zone where the accelerator pod controller resides.", +"readOnly": true, "type": "string" } }, "type": "object" }, -"AcceleratorTypeAggregatedList": { -"id": "AcceleratorTypeAggregatedList", +"AcceleratorPodControllersListResponse": { +"id": "AcceleratorPodControllersListResponse", "properties": { -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, "items": { -"additionalProperties": { -"$ref": "AcceleratorTypesScopedList", -"description": "[Output Only] Name of the scope containing this set of accelerator types." +"items": { +"$ref": "AcceleratorPodController" }, -"description": "A list of AcceleratorTypesScopedList resources.", -"type": "object" +"type": "array" }, "kind": { -"default": "compute#acceleratorTypeAggregatedList", -"description": "Output only. [Output Only] Type of resource. Alwayscompute#acceleratorTypeAggregatedList for aggregated lists of\naccelerator types.", -"readOnly": true, "type": "string" }, "nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", "type": "string" }, "selfLink": { -"description": "Output only. [Output Only] Server-defined URL for this resource.", -"readOnly": true, "type": "string" }, -"unreachables": { -"description": "Output only. [Output Only] Unreachable resources.", -"items": { -"type": "string" -}, -"readOnly": true, -"type": "array" -}, "warning": { -"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, +"AcceleratorTopologiesInfo": { +"description": "Info for accelerator topologies within a densely packed reservation.", +"id": "AcceleratorTopologiesInfo", +"properties": { +"acceleratorTopologyInfos": { +"description": "Info for each accelerator topology.", +"items": { +"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"AcceleratorTopologiesInfoAcceleratorTopologyInfo": { +"description": "Info for a slice of a given topology.", +"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo", +"properties": { +"acceleratorTopology": { +"description": "The accelerator topology.", +"type": "string" +}, +"infoPerTopologyStates": { +"description": "Info for each topology state.", +"items": { +"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState" +}, +"type": "array" +} +}, +"type": "object" +}, +"AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": { +"description": "Info for each topology state.", +"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState", +"properties": { +"count": { +"description": "The number of accelerator topologies in this state.", +"format": "int32", +"type": "integer" +}, +"state": { +"description": "The state of the accelerator topology.", +"enum": [ +"AVAILABLE", +"DEGRADED", +"RUNNING", +"TOPOLOGY_STATE_UNSPECIFIED", +"UNHEALTHY" +], +"enumDeprecated": [ +false, +false, +false, +false, +true +], +"enumDescriptions": [ +"The accelerator topology is available.", +"The accelerator topology is degraded. The underlying capacity is not in a\nhealthy state and is not available.", +"The accelerator topology is running. If there are both running and\ndegraded hosts within a topology, DEGRADED state will be returned.", +"The state of the topology is unspecified.", +"This value has been deprecated and is no longer used." +], +"type": "string" +} +}, +"type": "object" +}, +"AcceleratorType": { +"description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.", +"id": "AcceleratorType", +"properties": { +"creationTimestamp": { +"description": "[Output Only] Creation timestamp inRFC3339 text format.", +"type": "string" +}, +"deprecated": { +"$ref": "DeprecationStatus", +"description": "[Output Only] The deprecation status associated with this accelerator type." +}, +"description": { +"description": "[Output Only] An optional textual description of the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#acceleratorType", +"description": "Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types.", +"readOnly": true, +"type": "string" +}, +"maximumCardsPerInstance": { +"description": "[Output Only] Maximum number of accelerator cards allowed per instance.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "[Output Only] Name of the resource.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined, fully qualified URL for this resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.", +"readOnly": true, +"type": "string" +}, +"zone": { +"description": "[Output Only] The name of the zone where the accelerator type resides,\nsuch as us-central1-a.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.", +"type": "string" +} +}, +"type": "object" +}, +"AcceleratorTypeAggregatedList": { +"id": "AcceleratorTypeAggregatedList", +"properties": { +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"additionalProperties": { +"$ref": "AcceleratorTypesScopedList", +"description": "[Output Only] Name of the scope containing this set of accelerator types." +}, +"description": "A list of AcceleratorTypesScopedList resources.", +"type": "object" +}, +"kind": { +"default": "compute#acceleratorTypeAggregatedList", +"description": "Output only. [Output Only] Type of resource. Alwayscompute#acceleratorTypeAggregatedList for aggregated lists of\naccelerator types.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", "properties": { "code": { "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", @@ -57765,6 +58494,7 @@ false "type": "string" }, "publicDnsName": { +"deprecated": true, "description": "Output only. [Output Only] The public DNS domain name for the instance.", "readOnly": true, "type": "string" @@ -57778,6 +58508,7 @@ false "type": "string" }, "setPublicDns": { +"deprecated": true, "description": "Specifies whether a public DNS 'A' record should be created for the\nexternal IP address of this access configuration.", "type": "boolean" }, @@ -57840,7 +58571,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of external IPv4 addresses,\nlike a PublicDelegatedPrefix (PDP) for BYOIP.\nThe PDP must support enhanced IPv4 allocations.\n\nUse one of the following formats to specify a PDP when reserving an\nexternal IPv4 address using BYOIP.\n \n - \n Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - \n Partial URL, as in\n \n \n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -58516,6 +59247,18 @@ false "description": "An alias IP range attached to an instance's network interface.", "id": "AliasIpRange", "properties": { +"candidateSubnetworkRangeNames": { +"description": "Identifies the candidate subnetwork range names for the alias\nIPs to be allocated from. When it is set, the IP would be allocated from\nany subnetwork range defined here if the IPs are available.\nOnly one of subnetwork_range_name or candidate_subnetwork_range_names\nshould be set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"effectiveSubnetworkRangeName": { +"description": "Output only. [Output Only] The subnetwork range name where the IP is allocated.\nIt will be set to the subnetwork range where the IP is allocated only.", +"readOnly": true, +"type": "string" +}, "ipCidrRange": { "description": "The IP alias ranges to allocate for this interface. This IP CIDR range\nmust belong to the specified subnetwork and cannot contain IP addresses\nreserved by system or used by other network interfaces. This range may be\na single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).", "type": "string" @@ -59218,6 +59961,17 @@ false }, "type": "object" }, +"AuthenticationConfig": { +"description": "Authentication configuration for the management interface, typically using\nmTLS.", +"id": "AuthenticationConfig", +"properties": { +"trustConfig": { +"description": "Required. Resource name of the Cloud Certificate Manager TrustConfig used to validate\nclient certificates for mTLS.\nFormat: projects/{project}/locations/{location}/trustConfigs/{trust_config}", +"type": "string" +} +}, +"type": "object" +}, "AuthenticationPolicy": { "description": "[Deprecated] The authentication settings for the backend service.\nThe authentication settings for the backend service.", "id": "AuthenticationPolicy", @@ -63966,19 +64720,23 @@ false "id": "CapacityHistoryResponse", "properties": { "location": { +"description": "Output only. The location (region or zone) for which the capacity history is returned.\nIt is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone.", "readOnly": true, "type": "string" }, "machineType": { +"description": "The machine type for which the capacity history is returned.", "type": "string" }, "preemptionHistory": { +"description": "The preemption history for the requested machine type and location.", "items": { "$ref": "CapacityHistoryResponsePreemptionRecord" }, "type": "array" }, "priceHistory": { +"description": "The price history for the requested machine type and location.", "items": { "$ref": "CapacityHistoryResponsePriceRecord" }, @@ -63988,12 +64746,15 @@ false "type": "object" }, "CapacityHistoryResponsePreemptionRecord": { +"description": "A record of Spot VM preemption history.", "id": "CapacityHistoryResponsePreemptionRecord", "properties": { "interval": { -"$ref": "Interval" +"$ref": "Interval", +"description": "The time interval for this preemption record." }, "preemptionRate": { +"description": "The preemption rate during the interval, representing the fraction of\nSpot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is\ncalculated as (total preempted Spots) / (total Spots that stopped\nrunning).", "format": "double", "type": "number" } @@ -64001,13 +64762,16 @@ false "type": "object" }, "CapacityHistoryResponsePriceRecord": { +"description": "A record of price history.", "id": "CapacityHistoryResponsePriceRecord", "properties": { "interval": { -"$ref": "Interval" +"$ref": "Interval", +"description": "The time interval for this price record." }, "listPrice": { -"$ref": "Money" +"$ref": "Money", +"description": "The Spot VM list price during the interval." } }, "type": "object" @@ -65873,203 +66637,527 @@ false }, "type": "object" }, -"CustomErrorResponsePolicy": { -"description": "Specifies the custom error response policy that must be applied when the\nbackend service or backend bucket responds with an error.", -"id": "CustomErrorResponsePolicy", -"properties": { -"errorResponseRules": { -"description": "Specifies rules for returning error responses.\n\nIn a given policy, if you specify rules for both a range of error codes\nas well as rules for specific error codes then rules with specific error\ncodes have a higher priority. For example, assume that you configure a rule\nfor 401 (Un-authorized) code, and another for all 4 series\nerror codes (4XX). If the backend service returns a401, then the rule for 401 will be applied.\nHowever if the backend service returns a 403, the rule for4xx takes effect.", -"items": { -"$ref": "CustomErrorResponsePolicyCustomErrorResponseRule" -}, -"type": "array" -}, -"errorService": { -"description": "The full or partial URL to the BackendBucket resource that\ncontains the custom error content. Examples are:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket\n - compute/v1/projects/project/global/backendBuckets/myBackendBucket\n - global/backendBuckets/myBackendBucket\n\nIf errorService is not specified at lower levels likepathMatcher, pathRule and routeRule,\nan errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. \n\nIf load balancer cannot reach\nthe backendBucket, a simple Not Found Error will\nbe returned, with the original response code (oroverrideResponseCode if configured).\n\nerrorService is not supported for internal or regionalHTTP/HTTPS load balancers.", -"type": "string" -} -}, -"type": "object" -}, -"CustomErrorResponsePolicyCustomErrorResponseRule": { -"description": "Specifies the mapping between the response code that will be returned along\nwith the custom error content and the response code returned by the backend\nservice.", -"id": "CustomErrorResponsePolicyCustomErrorResponseRule", -"properties": { -"matchResponseCodes": { -"description": "Valid values include:\n \n \n - A number between 400 and 599: For example\n 401 or 503, in which case the load balancer\n applies the policy if the error code exactly matches this value.\n - 5xx: Load Balancer will apply the policy if the\n backend service responds with any response code in the range of\n 500 to 599. \n - 4xx: Load\n Balancer will apply the policy if the backend service responds with any\n response code in the range of 400 to\n 499.\n\nValues must be unique within matchResponseCodes and across allerrorResponseRules ofCustomErrorResponsePolicy.", -"items": { -"type": "string" -}, -"type": "array" -}, -"overrideResponseCode": { -"description": "The HTTP status code returned with the response containing the custom\nerror content. If overrideResponseCode is not supplied, the\nsame response code returned by the original backend bucket or backend\nservice is returned to the client.", -"format": "int32", -"type": "integer" -}, -"path": { -"description": "The full path to a file within backendBucket . For example:/errors/defaultError.html \n\npath must start\nwith a leading slash. path cannot have trailing slashes.\n\nIf the file is not available in backendBucket or the\nload balancer cannot reach the BackendBucket, a simpleNot Found Error is returned to the client. \n\nThe value must\nbe from 1 to 1024 characters", -"type": "string" -} -}, -"type": "object" -}, -"CustomerEncryptionKey": { -"id": "CustomerEncryptionKey", -"properties": { -"kmsKeyName": { -"description": "The name of the encryption key that is stored in Google Cloud KMS.\nFor example:\n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n\nThe fully-qualifed key name may be returned for resource GET requests. For \nexample: \n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n/cryptoKeyVersions/1", -"type": "string" -}, -"kmsKeyServiceAccount": { -"description": "The service account being used for the encryption request for the given KMS\nkey. If absent, the Compute Engine default service account is used.\nFor example:\n\n\"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com/", -"type": "string" -}, -"rawKey": { -"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", -"type": "string" -}, -"rsaEncryptedKey": { -"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", -"type": "string" -}, -"sha256": { -"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", -"type": "string" -} -}, -"type": "object" -}, -"CustomerEncryptionKeyProtectedDisk": { -"id": "CustomerEncryptionKeyProtectedDisk", -"properties": { -"diskEncryptionKey": { -"$ref": "CustomerEncryptionKey", -"description": "Decrypts data associated with the disk with acustomer-supplied\nencryption key." -}, -"source": { -"description": "Specifies a valid partial or full URL to an existing Persistent Disk\nresource. This field is only applicable for persistent disks.\nFor example:\n\n\"source\": \"/compute/v1/projects/project_id/zones/zone/disks/\ndisk_name", -"type": "string" -} -}, -"type": "object" -}, -"Date": { -"description": "Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:\n\n* A full date, with non-zero year, month, and day values.\n* A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day.\n* A year and month, with a zero day (for example, a credit card expiration\n date).\n\nRelated types:\n\n* google.type.TimeOfDay\n* google.type.DateTime\n* google.protobuf.Timestamp", -"id": "Date", -"properties": { -"day": { -"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant.", -"format": "int32", -"type": "integer" -}, -"month": { -"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day.", -"format": "int32", -"type": "integer" -}, -"year": { -"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"DateTime": { -"description": "Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year, month, or day are 0, the DateTime is considered not to have a\nspecific year, month, or day respectively.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations.", -"id": "DateTime", -"properties": { -"day": { -"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and\nmonth, or 0 if specifying a datetime without a day.", -"format": "int32", -"type": "integer" -}, -"hours": { -"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults\nto 0 (midnight). An API may choose to allow the value \"24:00:00\" for\nscenarios like business closing time.", -"format": "int32", -"type": "integer" -}, -"minutes": { -"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", -"format": "int32", -"type": "integer" -}, -"month": { -"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a\ndatetime without a month.", -"format": "int32", -"type": "integer" -}, -"nanos": { -"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999, defaults to 0.", -"format": "int32", -"type": "integer" -}, -"seconds": { -"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59,\ndefaults to 0. An API may allow the value 60 if it allows leap-seconds.", -"format": "int32", -"type": "integer" -}, -"timeZone": { -"$ref": "TimeZone", -"description": "Time zone." -}, -"utcOffset": { -"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.", -"format": "google-duration", -"type": "string" -}, -"year": { -"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"DeprecationStatus": { -"description": "Deprecation status for a public resource.", -"id": "DeprecationStatus", -"properties": { -"deleted": { -"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to DELETED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", -"type": "string" -}, -"deprecated": { -"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to DEPRECATED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", -"type": "string" -}, -"obsolete": { -"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to OBSOLETE. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", -"type": "string" -}, -"replacement": { -"description": "The URL of the suggested replacement for a deprecated resource.\nThe suggested replacement resource must be the same kind of resource as the\ndeprecated resource.", -"type": "string" -}, -"state": { -"description": "The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.\nOperations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a\nwarning indicating the deprecated resource and recommending its\nreplacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.", -"enum": [ -"ACTIVE", -"DELETED", -"DEPRECATED", -"OBSOLETE" -], -"enumDescriptions": [ -"", -"", -"", -"" -], -"type": "string" -}, -"stateOverride": { -"$ref": "RolloutPolicy", -"description": "The rollout policy for this deprecation. This policy is only enforced by\nimage family views. The rollout policy restricts the zones where the\nassociated resource is considered in a deprecated state. When the rollout\npolicy does not include the user specified zone, or if the zone is rolled\nout, the associated resource is considered in a deprecated state.\n\nThe rollout policy for this deprecation is read-only, except for\nallowlisted users. This field might not be configured. To view the latest\nnon-deprecated image in a specific zone, use theimageFamilyViews.get method." -} -}, -"type": "object" -}, +"CustomErrorResponsePolicy": { +"description": "Specifies the custom error response policy that must be applied when the\nbackend service or backend bucket responds with an error.", +"id": "CustomErrorResponsePolicy", +"properties": { +"errorResponseRules": { +"description": "Specifies rules for returning error responses.\n\nIn a given policy, if you specify rules for both a range of error codes\nas well as rules for specific error codes then rules with specific error\ncodes have a higher priority. For example, assume that you configure a rule\nfor 401 (Un-authorized) code, and another for all 4 series\nerror codes (4XX). If the backend service returns a401, then the rule for 401 will be applied.\nHowever if the backend service returns a 403, the rule for4xx takes effect.", +"items": { +"$ref": "CustomErrorResponsePolicyCustomErrorResponseRule" +}, +"type": "array" +}, +"errorService": { +"description": "The full or partial URL to the BackendBucket resource that\ncontains the custom error content. Examples are:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket\n - compute/v1/projects/project/global/backendBuckets/myBackendBucket\n - global/backendBuckets/myBackendBucket\n\nIf errorService is not specified at lower levels likepathMatcher, pathRule and routeRule,\nan errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. \n\nIf load balancer cannot reach\nthe backendBucket, a simple Not Found Error will\nbe returned, with the original response code (oroverrideResponseCode if configured).\n\nerrorService is not supported for internal or regionalHTTP/HTTPS load balancers.", +"type": "string" +} +}, +"type": "object" +}, +"CustomErrorResponsePolicyCustomErrorResponseRule": { +"description": "Specifies the mapping between the response code that will be returned along\nwith the custom error content and the response code returned by the backend\nservice.", +"id": "CustomErrorResponsePolicyCustomErrorResponseRule", +"properties": { +"matchResponseCodes": { +"description": "Valid values include:\n \n \n - A number between 400 and 599: For example\n 401 or 503, in which case the load balancer\n applies the policy if the error code exactly matches this value.\n - 5xx: Load Balancer will apply the policy if the\n backend service responds with any response code in the range of\n 500 to 599. \n - 4xx: Load\n Balancer will apply the policy if the backend service responds with any\n response code in the range of 400 to\n 499.\n\nValues must be unique within matchResponseCodes and across allerrorResponseRules ofCustomErrorResponsePolicy.", +"items": { +"type": "string" +}, +"type": "array" +}, +"overrideResponseCode": { +"description": "The HTTP status code returned with the response containing the custom\nerror content. If overrideResponseCode is not supplied, the\nsame response code returned by the original backend bucket or backend\nservice is returned to the client.", +"format": "int32", +"type": "integer" +}, +"path": { +"description": "The full path to a file within backendBucket . For example:/errors/defaultError.html \n\npath must start\nwith a leading slash. path cannot have trailing slashes.\n\nIf the file is not available in backendBucket or the\nload balancer cannot reach the BackendBucket, a simpleNot Found Error is returned to the client. \n\nThe value must\nbe from 1 to 1024 characters", +"type": "string" +} +}, +"type": "object" +}, +"CustomerEncryptionKey": { +"id": "CustomerEncryptionKey", +"properties": { +"kmsKeyName": { +"description": "The name of the encryption key that is stored in Google Cloud KMS.\nFor example:\n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n\nThe fully-qualifed key name may be returned for resource GET requests. For \nexample: \n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n/cryptoKeyVersions/1", +"type": "string" +}, +"kmsKeyServiceAccount": { +"description": "The service account being used for the encryption request for the given KMS\nkey. If absent, the Compute Engine default service account is used.\nFor example:\n\n\"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com/", +"type": "string" +}, +"rawKey": { +"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"", +"type": "string" +}, +"rsaEncryptedKey": { +"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n \n 1. The key is wrapped using a RSA public key certificate provided by \n Google. \n 2. After being wrapped, the key must be encoded in RFC 4648 base64 \n encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem", +"type": "string" +}, +"sha256": { +"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.", +"type": "string" +} +}, +"type": "object" +}, +"CustomerEncryptionKeyProtectedDisk": { +"id": "CustomerEncryptionKeyProtectedDisk", +"properties": { +"diskEncryptionKey": { +"$ref": "CustomerEncryptionKey", +"description": "Decrypts data associated with the disk with acustomer-supplied\nencryption key." +}, +"source": { +"description": "Specifies a valid partial or full URL to an existing Persistent Disk\nresource. This field is only applicable for persistent disks.\nFor example:\n\n\"source\": \"/compute/v1/projects/project_id/zones/zone/disks/\ndisk_name", +"type": "string" +} +}, +"type": "object" +}, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:\n\n* A full date, with non-zero year, month, and day values.\n* A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day.\n* A year and month, with a zero day (for example, a credit card expiration\n date).\n\nRelated types:\n\n* google.type.TimeOfDay\n* google.type.DateTime\n* google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DateTime": { +"description": "Represents civil time (or occasionally physical time).\n\nThis type can represent a civil time in one of a few possible ways:\n\n * When utc_offset is set and time_zone is unset: a civil time on a calendar\n day with a particular offset from UTC.\n * When time_zone is set and utc_offset is unset: a civil time on a calendar\n day in a particular time zone.\n * When neither time_zone nor utc_offset is set: a civil time on a calendar\n day in local time.\n\nThe date is relative to the Proleptic Gregorian Calendar.\n\nIf year, month, or day are 0, the DateTime is considered not to have a\nspecific year, month, or day respectively.\n\nThis type may also be used to represent a physical time if all the date and\ntime fields are set and either case of the `time_offset` oneof is set.\nConsider using `Timestamp` message for physical time instead. If your use\ncase also would like to store the user's timezone, that can be done in\nanother field.\n\nThis type is more flexible than some applications may want. Make sure to\ndocument and validate your application's limitations.", +"id": "DateTime", +"properties": { +"day": { +"description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and\nmonth, or 0 if specifying a datetime without a day.", +"format": "int32", +"type": "integer" +}, +"hours": { +"description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults\nto 0 (midnight). An API may choose to allow the value \"24:00:00\" for\nscenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a\ndatetime without a month.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to\n999,999,999, defaults to 0.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59,\ndefaults to 0. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Time zone." +}, +"utcOffset": { +"description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours.\nFor example, a UTC offset of -4:00 would be represented as\n{ seconds: -14400 }.", +"format": "google-duration", +"type": "string" +}, +"year": { +"description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a\ndatetime without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"DeprecationStatus": { +"description": "Deprecation status for a public resource.", +"id": "DeprecationStatus", +"properties": { +"deleted": { +"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to DELETED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", +"type": "string" +}, +"deprecated": { +"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to DEPRECATED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", +"type": "string" +}, +"obsolete": { +"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to OBSOLETE. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.", +"type": "string" +}, +"replacement": { +"description": "The URL of the suggested replacement for a deprecated resource.\nThe suggested replacement resource must be the same kind of resource as the\ndeprecated resource.", +"type": "string" +}, +"state": { +"description": "The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.\nOperations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a\nwarning indicating the deprecated resource and recommending its\nreplacement. Operations which use OBSOLETE orDELETED resources will be rejected and result in an error.", +"enum": [ +"ACTIVE", +"DELETED", +"DEPRECATED", +"OBSOLETE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"stateOverride": { +"$ref": "RolloutPolicy", +"description": "The rollout policy for this deprecation. This policy is only enforced by\nimage family views. The rollout policy restricts the zones where the\nassociated resource is considered in a deprecated state. When the rollout\npolicy does not include the user specified zone, or if the zone is rolled\nout, the associated resource is considered in a deprecated state.\n\nThe rollout policy for this deprecation is read-only, except for\nallowlisted users. This field might not be configured. To view the latest\nnon-deprecated image in a specific zone, use theimageFamilyViews.get method." +} +}, +"type": "object" +}, +"DhcpOptionsConfig": { +"description": "A standalone, regional API resource that encapsulates a set of user-defined\nDHCP configurations.", +"id": "DhcpOptionsConfig", +"properties": { +"associations": { +"additionalProperties": { +"$ref": "DhcpOptionsConfigAssociation" +}, +"description": "Mapping of user-defined keys to DhcpOptionsConfig to Network associations.", +"type": "object" +}, +"bootFileIpv4Name": { +"description": "The file path and name of the boot image/file on the TFTP server that the\nclient VM guest OS should download and execute during network boot. Used\nwhen the standard DHCP header 'file' field is overloaded. Corresponds to\nDHCPv4 Option 67.", +"type": "string" +}, +"bootFileIpv6Parameters": { +"description": "A list of UTF-8 encoded parameter strings to be passed as arguments to the\nbootloader program or OS kernel after downloading the boot file.\nCorresponds to DHCPv6 Option 60.", +"items": { +"type": "string" +}, +"type": "array" +}, +"bootFileIpv6Url": { +"description": "The Uniform Resource Locator (URL) specifying the protocol, server address,\nand file path of the boot file that the client VM guest OS should download\nand execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or\n'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.", +"type": "string" +}, +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional description of this resource. Provide this property when you\ncreate the resource.", +"type": "string" +}, +"dnsSearchPaths": { +"description": "An ordered list of domain suffixes (search paths) that the client VM guest\nOS should append to resolve hostnames that are not fully qualified. Applies\nto both DHCPv4 Option 119 and DHCPv6 Option 24.", +"items": { +"type": "string" +}, +"type": "array" +}, +"dnsServerIpv4Addresses": { +"description": "An ordered list of IPv4 addresses of DNS recursive name servers available\nto the client VM guest OS, specified in order of preference. Corresponds to\nDHCPv4 Option 6.", +"items": { +"type": "string" +}, +"type": "array" +}, +"dnsServerIpv6Addresses": { +"description": "An ordered list of IPv6 addresses of DNS recursive name servers available\nto the client VM guest OS, specified in order of preference. Corresponds to\nDHCPv6 Option 23.", +"items": { +"type": "string" +}, +"type": "array" +}, +"domainName": { +"description": "The domain name that the client VM guest OS should use when resolving\nhostnames via DNS (e.g., 'example.com'). It defines the default domain\nsuffix for the client. Corresponds to DHCPv4 Option 15.", +"type": "string" +}, +"id": { +"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"kind": { +"default": "compute#dhcpOptionsConfig", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.", +"readOnly": true, +"type": "string" +}, +"leaseTimeSec": { +"description": "The duration, in seconds, of the IPv4 address lease offered by the DHCP\nserver to the client VM guest OS. Corresponds to DHCPv4 Option 51.", +"format": "int64", +"type": "string" +}, +"name": { +"annotations": { +"required": [ +"compute.dhcpOptionsConfigs.insert" +] +}, +"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"ntpServerIpv4Addresses": { +"description": "An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers\navailable to the client VM guest OS for system clock synchronization,\nlisted in order of preference. Corresponds to DHCPv4 Option 42.", +"items": { +"type": "string" +}, +"type": "array" +}, +"ntpServerIpv6Addresses": { +"description": "An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers\navailable to the client VM guest OS for system clock synchronization.\nCorresponds to DHCPv6 Option 56.", +"items": { +"type": "string" +}, +"type": "array" +}, +"region": { +"description": "Output only. [Output Only] URL of the region where the resource resides.", +"readOnly": true, +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"tftpServerIpv4Addresses": { +"description": "An ordered list of one or more IPv4 addresses of TFTP servers. Provides\nserver redundancy and failover support, and is generally prioritized by\nclients over the single hostname specified in Option 66. Corresponds to\nDHCPv4 Option 150.", +"items": { +"type": "string" +}, +"type": "array" +}, +"tftpServerIpv4Name": { +"description": "The hostname or IP address of the Trivial File Transfer Protocol (TFTP)\nserver from which the client VM guest OS can download boot files. Typically\nused in network booting (PXE) when the standard DHCP header 'sname' field\nis overloaded. Corresponds to DHCPv4 Option 66.", +"type": "string" +} +}, +"type": "object" +}, +"DhcpOptionsConfigAssociation": { +"description": "Association represents the relationship between a DHCP options config and a\nnetwork. Association represents the relationship between a DHCP options\nconfig and a network.", +"id": "DhcpOptionsConfigAssociation", +"properties": { +"network": { +"description": "Required. The target network this DHCP option is attached to.\nYou can specify this as a full or partial URL. For example, the following\nare all valid URLs:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/networks/network\n \n - projects/project/global/networks/network", +"type": "string" +}, +"networkId": { +"description": "Output only. [Output Only] The server-defined ID of the associated Network.", +"format": "uint64", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. [Output Only] State of the association.", +"enum": [ +"ACTIVE", +"ORPHANED", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"The association is active and the DHCP configuration is applied.", +"The association is orphaned (the network has been deleted).", +"Default value. This value is unused." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DhcpOptionsConfigList": { +"id": "DhcpOptionsConfigList", +"properties": { +"etag": { +"description": "Server-defined ETag for optimistic concurrency control.", +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of DhcpOptionsConfig resources.", +"items": { +"$ref": "DhcpOptionsConfig" +}, +"type": "array" +}, +"kind": { +"default": "compute#dhcpOptionsConfigList", +"description": "Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfigList for a list of dhcp options\nconfigs.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "Disk": { "description": "Represents a Persistent Disk resource.\n\nGoogle Compute Engine has two Disk resources:\n\n* [Zonal](/compute/docs/reference/rest/alpha/disks)\n* [Regional](/compute/docs/reference/rest/alpha/regionDisks)\n\nPersistent disks are required for running your VM instances.\nCreate both boot and non-boot (data) persistent disks. For more information,\nread Persistent Disks. For more\nstorage options, read Storage options.\n\nThe disks resource represents a zonal persistent disk.\nFor more information, readZonal persistent disks.\n\nThe regionDisks resource represents a\nregional persistent disk. For more information, read\nRegional resources.", "id": "Disk", @@ -69345,7 +70433,7 @@ false "id": "FirewallPolicyRule", "properties": { "action": { -"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\".\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", +"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\" (\n\"apply_security_profile_group\" can be specified only for global\nnetwork firewall policies or hierarchical firewall policies).\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", "type": "string" }, "description": { @@ -69398,7 +70486,7 @@ false "type": "integer" }, "securityProfileGroup": { -"description": "A fully-qualified URL of a SecurityProfile resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions.", +"description": "A fully-qualified URL of a SecurityProfileGroup resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions. Can be specified only\nfor global network firewall policies or hierarchical firewall policies.", "type": "string" }, "targetForwardingRules": { @@ -70879,6 +71967,10 @@ false "description": "Name of reservations where the capacity is provisioned at the time of\ndelivery of future reservations. If the reservation with the given name\ndoes not exist already, it is created automatically at the time of Approval\nwith INACTIVE state till specified start-time. Either provide the\nreservation_name or a name_prefix.", "type": "string" }, +"resourceName": { +"description": "Name of the resource intended to be delivered. Name should conform to\nRFC1035. This will be the name of storage pool or Exapool for persistent\ndisk FRs.", +"type": "string" +}, "schedulingType": { "description": "Maintenance information for this reservation", "enum": [ @@ -70920,6 +72012,10 @@ false "description": "Output only. [Output only] Status of the Future Reservation", "readOnly": true }, +"storagePoolProperties": { +"$ref": "FutureReservationStoragePoolProperties", +"description": "Storage pool details for the future reservation." +}, "timeWindow": { "$ref": "FutureReservationTimeWindow", "description": "Time window for this Future Reservation." @@ -71034,6 +72130,11 @@ false "readOnly": true, "type": "array" }, +"exapoolProvisionedCapacityGb": { +"$ref": "StoragePoolExapoolProvisionedCapacityGb", +"description": "Output only. Exapool provisioned capacities for each SKU type.", +"readOnly": true +}, "existingMatchingUsageInfo": { "$ref": "FutureReservationStatusExistingMatchingUsageInfo", "description": "Output only. [Output Only] Represents the existing matching usage for the future\nreservation.", @@ -71092,6 +72193,11 @@ false }, "specificSkuProperties": { "$ref": "FutureReservationStatusSpecificSKUProperties" +}, +"storagePoolProvisionedCapacity": { +"$ref": "FutureReservationStoragePoolProvisionedCapacity", +"description": "Output only. Storage pool provisioned capacities for each SKU type.", +"readOnly": true } }, "type": "object" @@ -71213,6 +72319,47 @@ false }, "type": "object" }, +"FutureReservationStoragePoolProperties": { +"description": "Storage pool properties for the future reservation.", +"id": "FutureReservationStoragePoolProperties", +"properties": { +"requestedExapoolProvisionedCapacityGb": { +"$ref": "StoragePoolExapoolProvisionedCapacityGb", +"description": "Requested exapool provisioned capacity in GiB." +}, +"requestedStoragePoolProvisionedCapacity": { +"$ref": "FutureReservationStoragePoolProvisionedCapacity", +"description": "Requested storage pool provisioned capacity." +}, +"storagePoolType": { +"description": "Type of the storage pool.", +"type": "string" +} +}, +"type": "object" +}, +"FutureReservationStoragePoolProvisionedCapacity": { +"description": "Storage pool provisioned capacities for each SKU type.", +"id": "FutureReservationStoragePoolProvisionedCapacity", +"properties": { +"poolProvisionedCapacityGb": { +"description": "Size of the storage pool in GiB.", +"format": "int64", +"type": "string" +}, +"poolProvisionedIops": { +"description": "Provisioned IOPS of the storage pool. Only relevant if the storage pool\ntype is hyperdisk-balanced.", +"format": "int64", +"type": "string" +}, +"poolProvisionedThroughput": { +"description": "Provisioned throughput of the storage pool in MiB/s. Only relevant if\nthe storage pool type is hyperdisk-balanced or hyperdisk-throughput.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "FutureReservationTimeWindow": { "id": "FutureReservationTimeWindow", "properties": { @@ -78620,6 +79767,20 @@ false "readOnly": true, "type": "string" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "description": "Full or partial URL of the machine type resource to use for this instance,\nin the format:zones/zone/machineTypes/machine-type. This is provided by the client\nwhen the instance is created. For example, the following is a valid partial\nurl to a predefined\nmachine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo create acustom\nmachine type, provide a URL to a machine type in the following format,\nwhere CPUS is 1 or an even number up to 32 (2,\n4, 6, ... 24, etc), and MEMORY is the total\nmemory for this instance. Memory must be a multiple of 256 MB and must\nbe supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120\nFor a full list of restrictions, read theSpecifications\nfor custom machine types.", "type": "string" @@ -83094,6 +84255,20 @@ false "description": "Labels to apply to instances that are created from these properties.", "type": "object" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "annotations": { "required": [ @@ -92011,12 +93186,12 @@ false }, "scheduling": { "$ref": "ManagedInstanceScheduling", -"description": "Output only. [Output Only] Information about the termination timestamp of the instance,\nif applicable.", +"description": "Output only. Information about the termination timestamp of the instance, if applicable.", "readOnly": true }, "shutdownDetails": { "$ref": "ManagedInstanceShutdownDetails", -"description": "Output only. [Output Only] Specifies the graceful shutdown details if the instance is in\n`PENDING_STOP` state or there is a programmed stop scheduled.", +"description": "Output only. Specifies the graceful shutdown details if the instance is in\n`PENDING_STOP` state or there is a programmed stop scheduled.", "readOnly": true }, "sizeInUnit": { @@ -92077,7 +93252,7 @@ false "type": "string" }, "trigger": { -"description": "Output only. [Output Only] Details of the current action that the managed instance\ngroup has scheduled for the instance. Contains trigger for the current\naction, and methodName in case it was triggered by API call. Possible\nvalues for trigger:\n \n - API Any API call.\n - PROACTIVE_UPDATE Proactive updater scheduled an update\n on this managed instance.\n - AUTOSCALING Instance being deleted/created after a\n decision from the Autoscaler.\n - REDISTRIBUTION The regional managed instance group is\n moving instances between zones to restore balance.\n - STANDBY_REFILL The managed instance group is refilling\n the Standby Pool (stopped/suspended virtual machines) after scale\n up.\n - MAINTENANCE Manual maintenance.\n - FAILED_CREATION The managed instance group is handling\n failed instance creation.\n - INSTANCE_FAILURE The managed instance group is handling\n instance failure, according to\n the Instance Lifecycle Policy.\n - FAILED_HEALTH_CHECK The managed instance group is\n handling failed health check, according to the Instance Lifecycle\n Policy.\n - TERMINATION_TIMESTAMP Instance reached termination time,\n thus managed instance group stops/deletes it.", +"description": "Output only. [Output Only] Details of the current action that the managed instance\ngroup has scheduled for the instance. Contains trigger for the current\naction, and methodName in case it was triggered by API call. Possible\nvalues for trigger:\n \n - API Any API call.\n - PROACTIVE_UPDATE Proactive updater scheduled an update\n on this managed instance.\n - AUTOSCALING Instance being deleted/created after a\n decision from the Autoscaler.\n - REDISTRIBUTION The regional managed instance group is\n moving instances between zones to restore balance.\n - STANDBY_REFILL The managed instance group is refilling\n the Standby Pool (stopped/suspended virtual machines) after scale\n up.\n - MAINTENANCE Manual maintenance.\n - FAILED_CREATION The managed instance group is handling\n failed instance creation.\n - INSTANCE_FAILURE The managed instance group is handling\n instance failure, according to\n the Instance Lifecycle Policy.\n - FAILED_HEALTH_CHECK The managed instance group is\n handling failed health check, according to the Instance Lifecycle\n Policy.\n - TERMINATION_TIMESTAMP Instance reached termination time,\n thus managed instance group stops/deletes it.\n - GRACEFUL_SHUTDOWN_TIMESTAMP Instance reached graceful\n shutdown time, thus managed instance group stops/deletes it to\n gracefully shut it down.", "enum": [ "API", "AUTOSCALING", @@ -92289,13 +93464,13 @@ false "id": "ManagedInstanceScheduling", "properties": { "gracefulShutdownTimestamp": { -"description": "Output only. [Output Only] The timestamp at which the underlying instance will be\ntriggered for graceful shutdown if it is configured. This is in RFC3339 text format.", +"description": "Output only. The timestamp at which the underlying instance will be\ntriggered for graceful shutdown if it is configured. This is in RFC3339 text format.", "format": "google-datetime", "readOnly": true, "type": "string" }, "terminationTimestamp": { -"description": "Output only. [Output Only] The timestamp at which the managed instance will be\nterminated. This is in RFC3339 text format.", +"description": "Output only. The timestamp at which the managed instance will be terminated. This is\nin RFC3339 text\nformat.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -92308,11 +93483,11 @@ false "properties": { "maxDuration": { "$ref": "Duration", -"description": "Output only. [Output Only] The duration for graceful shutdown. Only applicable when\nthe instance is in `PENDING_STOP` state.", +"description": "Output only. The duration for graceful shutdown. Only applicable when the instance is\nin `PENDING_STOP` state.", "readOnly": true }, "requestTimestamp": { -"description": "Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP`\nstate of instance in RFC3339 text format.", +"description": "Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of\ninstance in RFC3339\ntext format.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -92336,6 +93511,62 @@ false }, "type": "object" }, +"ManagementInterface": { +"description": "Represents a managed interface for an accelerator domain.\nIt defines the network endpoint and authentication configuration needed to\naccess specific management services like NMX-C or gNMI.", +"id": "ManagementInterface", +"properties": { +"authenticationConfig": { +"$ref": "AuthenticationConfig" +}, +"ipv4Address": { +"description": "The IPv4 internal IP address assigned to this management interface\nendpoint. This address will be used by the customer to route traffic to the\nmanagement interface.", +"type": "string" +}, +"ipv6Address": { +"description": "The IPv6 internal IP address assigned to this management interface\nendpoint. This address will be used by the customer to route traffic to the\nmanagement interface if IPv6 is supported and configured.", +"type": "string" +}, +"network": { +"description": "The URL of the VPC network to which the management interface endpoint is\nattached. The customer must ensure that this network is correctly\nconfigured for routing to the accelerator domain.", +"type": "string" +}, +"state": { +"enum": [ +"ACTIVE", +"INACTIVE", +"PENDING", +"STATE_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"readOnly": true, +"type": "string" +}, +"subnetwork": { +"description": "The URL of the subnetwork from which to assign the IP address for the\nendpoint. The subnetwork must belong to the specified network and have\navailable IP addresses.", +"type": "string" +}, +"type": { +"description": "Required. The type of management service this interface provides.\nSupported types include NMX-C for partition management and gNMI for switch\nmonitoring.", +"enum": [ +"TYPE_NVLINK_PARTITION_MANAGEMENT", +"TYPE_NVLINK_SWITCH_MONITORING", +"TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "Metadata": { "description": "A metadata key/value entry.", "id": "Metadata", @@ -93353,14 +94584,14 @@ false "type": "string" }, "producerAcceptLists": { -"description": "Projects that are allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are allowed to connect to this network\nattachment. The project can be specified using its id or number. Service\nclass id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, "type": "array" }, "producerRejectLists": { -"description": "Projects that are not allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are not allowed to connect to this\nnetwork attachment. The project can be specified using its id or number.\nService class id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, @@ -108669,7 +109900,7 @@ false "id": "ReliabilityRisk", "properties": { "creationTimestamp": { -"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.", +"description": "Output only. [Output Only] Creation timestamp in RFC3339\ntext format.", "readOnly": true, "type": "string" }, @@ -108693,13 +109924,13 @@ false "type": "string" }, "name": { -"description": "Name of the resource. The name must be 1-63 characters long and\ncomply withRFC1035.", +"description": "Name of the resource. The name must be 1-63 characters long and\ncomply with RFC1035.", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, "recommendation": { "$ref": "RiskRecommendation", -"description": "The recommendations to mitigate the risk." +"description": "The recommendation to mitigate the risk." }, "selfLink": { "description": "Output only. [Output Only] Server-defined URL for the resource.", @@ -108715,6 +109946,7 @@ false "type": "object" }, "ReliabilityRisksListResponse": { +"description": "Response message for the List method of ReliabilityRisksService.", "id": "ReliabilityRisksListResponse", "properties": { "etag": { @@ -112179,6 +113411,11 @@ false "format": "int32", "type": "integer" }, +"gracefulShutdownTimestamp": { +"description": "Output only. Specifies the timestamp, when the instance will start graceful shutdown\nprocess, in RFC3339 text format.", +"readOnly": true, +"type": "string" +}, "terminationTimestamp": { "description": "Time in future when the instance will be terminated inRFC3339 text format.", "type": "string" @@ -112265,7 +113502,7 @@ false "type": "object" }, "RiskDetails": { -"description": "Details about a risk.", +"description": "Detailed insights and metrics about a detected reliability risk.", "id": "RiskDetails", "properties": { "duration": { @@ -112274,7 +113511,8 @@ false "type": "string" }, "globalDnsInsight": { -"$ref": "RiskDetailsGlobalDnsInsight" +"$ref": "RiskDetailsGlobalDnsInsight", +"description": "Insight details for global DNS risk." }, "lastUpdateTimestamp": { "description": "The last time the risk was updated.", @@ -112315,10 +113553,11 @@ false "type": "object" }, "RiskDetailsGlobalDnsInsight": { +"description": "Detailed insights for a global DNS reliability risk.", "id": "RiskDetailsGlobalDnsInsight", "properties": { "projectDefaultIsGlobalDns": { -"description": "Whether the project default DNS setting is global or not.", +"description": "Indicates whether the project's default DNS setting is global DNS.", "type": "boolean" }, "queryObservationWindow": { @@ -112327,7 +113566,7 @@ false "type": "string" }, "riskyQueryCount": { -"description": "The number of queries that are risky. This will always be less than\ntotal_query_count.", +"description": "The number of queries that are risky. This is always less than or\nequal to total_query_count.", "format": "int64", "type": "string" }, @@ -112340,7 +113579,7 @@ false "type": "object" }, "RiskRecommendation": { -"description": "Recommendation with reference url.", +"description": "Recommendation for mitigating a reliability risk, including a reference URL.", "id": "RiskRecommendation", "properties": { "content": { @@ -115028,6 +116267,11 @@ false "bfdStatus": { "$ref": "BfdStatus" }, +"depreferenced": { +"description": "Output only. [Output Only] Indicates whether the BGP peer is in a depreferenced state.", +"readOnly": true, +"type": "boolean" +}, "enableIpv4": { "description": "Output only. Enable IPv4 traffic over BGP Peer.\nIt is enabled by default if the peerIpAddress is version 4.", "readOnly": true, @@ -121816,7 +123060,6 @@ false "id": "SslPolicyReference", "properties": { "sslPolicy": { -"description": "URL of the SSL policy resource. Set this to empty string to clear any\nexisting SSL policy associated with the target proxy resource.", "type": "string" } }, @@ -133081,6 +134324,19 @@ false }, "identityCertificateEnabled": { "type": "boolean" +}, +"identityType": { +"enum": [ +"AGENT_IDENTITY", +"IDENTITY_TYPE_UNSPECIFIED", +"SERVICE_ACCOUNT" +], +"enumDescriptions": [ +"", +"", +"" +], +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 7b109cf385..2e072ad053 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -2278,7 +2278,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project.\nBackend services for external and internal passthrough Network Load\nBalancers are not included in the response.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -26972,7 +26972,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project in\nthe given region.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project in the\ngiven region. Backend services for external and internal passthrough\nNetwork Load Balancers are not included in the response.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -39533,6 +39533,100 @@ } } }, +"reliabilityRisks": { +"methods": { +"get": { +"description": "Returns the specified ReliabilityRisk resource.", +"flatPath": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", +"httpMethod": "GET", +"id": "compute.reliabilityRisks.get", +"parameterOrder": [ +"project", +"reliabilityRisk" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"reliabilityRisk": { +"description": "Name of the ReliabilityRisk resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/reliabilityRisks/{reliabilityRisk}", +"response": { +"$ref": "ReliabilityRisk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"list": { +"description": "Retrieves the list of reliabilityRisks available in the specified project.", +"flatPath": "projects/{project}/global/reliabilityRisks", +"httpMethod": "GET", +"id": "compute.reliabilityRisks.list", +"parameterOrder": [ +"project" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/global/reliabilityRisks", +"response": { +"$ref": "ReliabilityRisksListResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "reservationBlocks": { "methods": { "get": { @@ -52666,7 +52760,7 @@ } } }, -"revision": "20260625", +"revision": "20260629", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -53393,7 +53487,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of external IPv4 addresses,\nlike a PublicDelegatedPrefix (PDP) for BYOIP.\nThe PDP must support enhanced IPv4 allocations.\n\nUse one of the following formats to specify a PDP when reserving an\nexternal IPv4 address using BYOIP.\n \n - \n Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - \n Partial URL, as in\n \n \n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -59242,19 +59336,23 @@ false "id": "CapacityHistoryResponse", "properties": { "location": { +"description": "Output only. The location (region or zone) for which the capacity history is returned.\nIt is returned as a URL - For example,https://www.googleapis.com/compute/v1/projects/project/zones/zone.", "readOnly": true, "type": "string" }, "machineType": { +"description": "The machine type for which the capacity history is returned.", "type": "string" }, "preemptionHistory": { +"description": "The preemption history for the requested machine type and location.", "items": { "$ref": "CapacityHistoryResponsePreemptionRecord" }, "type": "array" }, "priceHistory": { +"description": "The price history for the requested machine type and location.", "items": { "$ref": "CapacityHistoryResponsePriceRecord" }, @@ -59264,12 +59362,15 @@ false "type": "object" }, "CapacityHistoryResponsePreemptionRecord": { +"description": "A record of Spot VM preemption history.", "id": "CapacityHistoryResponsePreemptionRecord", "properties": { "interval": { -"$ref": "Interval" +"$ref": "Interval", +"description": "The time interval for this preemption record." }, "preemptionRate": { +"description": "The preemption rate during the interval, representing the fraction of\nSpot VMs that were preempted. Range: 0.0 to 1.0. Preemption rate is\ncalculated as (total preempted Spots) / (total Spots that stopped\nrunning).", "format": "double", "type": "number" } @@ -59277,13 +59378,16 @@ false "type": "object" }, "CapacityHistoryResponsePriceRecord": { +"description": "A record of price history.", "id": "CapacityHistoryResponsePriceRecord", "properties": { "interval": { -"$ref": "Interval" +"$ref": "Interval", +"description": "The time interval for this price record." }, "listPrice": { -"$ref": "Money" +"$ref": "Money", +"description": "The Spot VM list price during the interval." } }, "type": "object" @@ -59337,11 +59441,13 @@ false "enum": [ "CATEGORY_UNSPECIFIED", "LICENSE", -"MACHINE" +"MACHINE", +"PERSISTENT_DISK" ], "enumDescriptions": [ "", "", +"", "" ], "type": "string" @@ -59402,6 +59508,13 @@ false "$ref": "CommitmentParams", "description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload." }, +"persistentDiskResources": { +"description": "Optional. Used when category is PERSISTENT_DISK.\nEach entry in the list represents a commitment to a specific Persistent\nDisk product type and dimension.", +"items": { +"$ref": "PersistentDiskResourceCommitment" +}, +"type": "array" +}, "plan": { "description": "The minimum time duration that you commit to purchasing resources.\nThe plan that you choose determines the preset term length of the\ncommitment (which is 1 year or 3 years) and affects the discount rate that\nyou receive for your resources. Committing to a longer time duration\ntypically gives you a higher discount rate. The supported values for this\nfield are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).", "enum": [ @@ -64197,7 +64310,7 @@ false "id": "FirewallPolicyRule", "properties": { "action": { -"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\".\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", +"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\" (\n\"apply_security_profile_group\" can be specified only for global\nnetwork firewall policies or hierarchical firewall policies).\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", "type": "string" }, "description": { @@ -64250,7 +64363,7 @@ false "type": "integer" }, "securityProfileGroup": { -"description": "A fully-qualified URL of a SecurityProfile resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions.", +"description": "A fully-qualified URL of a SecurityProfileGroup resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions. Can be specified only\nfor global network firewall policies or hierarchical firewall policies.", "type": "string" }, "targetForwardingRules": { @@ -71831,6 +71944,20 @@ false "readOnly": true, "type": "string" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "description": "Full or partial URL of the machine type resource to use for this instance,\nin the format:zones/zone/machineTypes/machine-type. This is provided by the client\nwhen the instance is created. For example, the following is a valid partial\nurl to a predefined\nmachine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo create acustom\nmachine type, provide a URL to a machine type in the following format,\nwhere CPUS is 1 or an even number up to 32 (2,\n4, 6, ... 24, etc), and MEMORY is the total\nmemory for this instance. Memory must be a multiple of 256 MB and must\nbe supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120\nFor a full list of restrictions, read theSpecifications\nfor custom machine types.", "type": "string" @@ -76102,6 +76229,20 @@ false "description": "Labels to apply to instances that are created from these properties.", "type": "object" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "annotations": { "required": [ @@ -83878,12 +84019,12 @@ false }, "scheduling": { "$ref": "ManagedInstanceScheduling", -"description": "Output only. [Output Only] Information about the termination timestamp of the instance,\nif applicable.", +"description": "Output only. Information about the termination timestamp of the instance, if applicable.", "readOnly": true }, "shutdownDetails": { "$ref": "ManagedInstanceShutdownDetails", -"description": "Output only. [Output Only] Specifies the graceful shutdown details if the instance is in\n`PENDING_STOP` state or there is a programmed stop scheduled.", +"description": "Output only. Specifies the graceful shutdown details if the instance is in\n`PENDING_STOP` state or there is a programmed stop scheduled.", "readOnly": true }, "targetStatus": { @@ -84052,13 +84193,13 @@ false "id": "ManagedInstanceScheduling", "properties": { "gracefulShutdownTimestamp": { -"description": "Output only. [Output Only] The timestamp at which the underlying instance will be\ntriggered for graceful shutdown if it is configured. This is in RFC3339 text format.", +"description": "Output only. The timestamp at which the underlying instance will be\ntriggered for graceful shutdown if it is configured. This is in RFC3339 text format.", "format": "google-datetime", "readOnly": true, "type": "string" }, "terminationTimestamp": { -"description": "Output only. [Output Only] The timestamp at which the managed instance will be\nterminated. This is in RFC3339 text format.", +"description": "Output only. The timestamp at which the managed instance will be terminated. This is\nin RFC3339 text\nformat.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -84071,11 +84212,11 @@ false "properties": { "maxDuration": { "$ref": "Duration", -"description": "Output only. [Output Only] The duration for graceful shutdown. Only applicable when\nthe instance is in `PENDING_STOP` state.", +"description": "Output only. The duration for graceful shutdown. Only applicable when the instance is\nin `PENDING_STOP` state.", "readOnly": true }, "requestTimestamp": { -"description": "Output only. [Output Only] Past timestamp indicating the beginning of `PENDING_STOP`\nstate of instance in RFC3339 text format.", +"description": "Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of\ninstance in RFC3339\ntext format.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -85069,14 +85210,14 @@ false "type": "string" }, "producerAcceptLists": { -"description": "Projects that are allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are allowed to connect to this network\nattachment. The project can be specified using its id or number. Service\nclass id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, "type": "array" }, "producerRejectLists": { -"description": "Projects that are not allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are not allowed to connect to this\nnetwork attachment. The project can be specified using its id or number.\nService class id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, @@ -93975,6 +94116,48 @@ false }, "type": "object" }, +"PersistentDiskResourceCommitment": { +"description": "Commitment for a particular persistent disk resource.", +"id": "PersistentDiskResourceCommitment", +"properties": { +"amount": { +"description": "Required. The amount of the resource to commit to, in GiB.", +"format": "int64", +"type": "string" +}, +"dimensionType": { +"description": "The specific dimension of the product for this amount.", +"enum": [ +"CAPACITY_OPTIMIZED", +"DIMENSION_TYPE_UNSPECIFIED", +"READ_OPTIMIZED", +"WRITE_OPTIMIZED" +], +"enumDescriptions": [ +"Dimensions for HYPERDISK_EXAPOOL_*\nRepresents a commitment for HYPERDISK_EXAPOOL_CAPACITY_CAPACITY_OPTIMIZED\nSKU.", +"", +"", +"" +], +"type": "string" +}, +"productType": { +"description": "The PD product being committed to. All entries in a\nCommitment.persistent_disk_resources list must have the same product_type.", +"enum": [ +"HYPERDISK_EXAPOOL_BALANCED", +"HYPERDISK_EXAPOOL_THROUGHPUT", +"PRODUCT_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Represents a commitment for Hyperdisk Exapool Balanced.", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members`, or principals, to a single `role`. Principals can be user\naccounts, service accounts, Google groups, and domains (such as G Suite). A\n`role` is a named list of permissions; each `role` can be an IAM predefined\nrole or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n```\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\n \"user:eve@example.com\"\n ],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ],\n \"etag\": \"BwWWja0YfJA=\",\n \"version\": 3\n }\n```\n\n**YAML example:**\n\n```\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n etag: BwWWja0YfJA=\n version: 3\n```\n\nFor a description of IAM and its features, see the\n[IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -96151,6 +96334,21 @@ false }, "type": "object" }, +"RegexRewrite": { +"description": "The spec for modifying the path using a regular expression.", +"id": "RegexRewrite", +"properties": { +"pathPattern": { +"description": "The regular expression used to match against the URL path.\nIt uses RE2 syntax with the following constraints:\n \n \n - Any single character operators\n - Groups are allowed to have only submatch operator inside\n - Groups are allowed only without any char repetition, e.g.\n .*\n - Any char repetition, e.g. .*, is\n only allowed to be used in a single regex together with:\n \n \n - Empty string operators\n - Other repetitions\n - Ranges\n - Repetitions of ranges\n \n \n - Ranges are only allowed to have:\n \n \n - Character range\n - Digits range\n - Symbols listed in characters allowed for ranges", +"type": "string" +}, +"pathSubstitution": { +"description": "Required when path pattern is specified. Used to rewrite matching parts of\nthe path.", +"type": "string" +} +}, +"type": "object" +}, "Region": { "description": "Represents a Region resource.\n\nA region is a geographical area where a resource is located. For more\ninformation, readRegions\nand Zones.", "id": "Region", @@ -98250,6 +98448,218 @@ false }, "type": "object" }, +"ReliabilityRisk": { +"description": "Represents a ReliabilityRisk resource.", +"id": "ReliabilityRisk", +"properties": { +"creationTimestamp": { +"description": "Output only. [Output Only] Creation timestamp in RFC3339\ntext format.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "An optional textual description of the resource; provided when the\nresource is created.", +"type": "string" +}, +"details": { +"$ref": "RiskDetails", +"description": "[Output Only] Details of the reliability risk resource" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#reliabilityRisk", +"description": "Output only. [Output Only] Type of resource. Always compute#reliabilityRisk\nfor reliability risks.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Name of the resource. The name must be 1-63 characters long and\ncomply with RFC1035.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"recommendation": { +"$ref": "RiskRecommendation", +"description": "The recommendation to mitigate the risk." +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for the resource.", +"readOnly": true, +"type": "string" +}, +"selfLinkWithId": { +"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReliabilityRisksListResponse": { +"description": "Response message for the List method of ReliabilityRisksService.", +"id": "ReliabilityRisksListResponse", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of ReliabilityRisk resources.", +"items": { +"$ref": "ReliabilityRisk" +}, +"type": "array" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "RequestMirrorPolicy": { "description": "A policy that specifies how requests intended for the route's backends\nare shadowed to a separate mirrored backend service. The load balancer\ndoesn't wait for responses from the shadow service. Before sending traffic\nto the shadow service, the host or authority header is suffixed with-shadow.", "id": "RequestMirrorPolicy", @@ -101329,6 +101739,98 @@ false }, "type": "object" }, +"RiskDetails": { +"description": "Detailed insights and metrics about a detected reliability risk.", +"id": "RiskDetails", +"properties": { +"duration": { +"description": "The duration of the risk since it was detected.", +"format": "google-duration", +"type": "string" +}, +"globalDnsInsight": { +"$ref": "RiskDetailsGlobalDnsInsight", +"description": "Insight details for global DNS risk." +}, +"lastUpdateTimestamp": { +"description": "The last time the risk was updated.", +"format": "google-datetime", +"type": "string" +}, +"severity": { +"description": "The severity of the risk.", +"enum": [ +"CRITICAL", +"HIGH", +"LOW", +"MEDIUM", +"SEVERITY_UNSPECIFIED" +], +"enumDescriptions": [ +"Critical severity.", +"High severity.", +"Low severity.", +"Medium severity.", +"No severity specified. The default value." +], +"type": "string" +}, +"type": { +"description": "The type of risk.", +"enum": [ +"GLOBAL_DNS", +"RISK_TYPE_UNSPECIFIED" +], +"enumDescriptions": [ +"Risk type related to global DNS.", +"Default value. This value is unused." +], +"type": "string" +} +}, +"type": "object" +}, +"RiskDetailsGlobalDnsInsight": { +"description": "Detailed insights for a global DNS reliability risk.", +"id": "RiskDetailsGlobalDnsInsight", +"properties": { +"projectDefaultIsGlobalDns": { +"description": "Indicates whether the project's default DNS setting is global DNS.", +"type": "boolean" +}, +"queryObservationWindow": { +"description": "The observation window for the query counts.", +"format": "google-duration", +"type": "string" +}, +"riskyQueryCount": { +"description": "The number of queries that are risky. This is always less than or\nequal to total_query_count.", +"format": "int64", +"type": "string" +}, +"totalQueryCount": { +"description": "The total number of queries in the observation window.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"RiskRecommendation": { +"description": "Recommendation for mitigating a reliability risk, including a reference URL.", +"id": "RiskRecommendation", +"properties": { +"content": { +"description": "Mitigation guide for the risk.", +"type": "string" +}, +"referenceUrl": { +"description": "URL referencing a more detailed mitigation guide.", +"type": "string" +} +}, +"type": "object" +}, "Rollout": { "description": "Rollout resource.\n\nA Rollout is a specific instance of a RolloutPlan. It represents a single\nexecution of a strategy to roll out a specific resource. It also provides\nAPIs to interact with the rollout.", "id": "Rollout", @@ -110364,7 +110866,6 @@ false "id": "SslPolicyReference", "properties": { "sslPolicy": { -"description": "URL of the SSL policy resource. Set this to empty string to clear any\nexisting SSL policy associated with the target proxy resource.", "type": "string" } }, @@ -112108,6 +112609,22 @@ false "readOnly": true, "type": "string" }, +"ipv6NetworkTier": { +"description": "Specifies the network tier for EXTERNAL IPv6. Can only be set when\nipv6_access_type is EXTERNAL. Defaults to project defaultNetworkTier if not\nspecified during the creation of the subnetwork. This field is IMMUTABLE\nonce set with EXTERNAL IPv6.", +"enum": [ +"FIXED_STANDARD", +"PREMIUM", +"STANDARD", +"STANDARD_OVERRIDES_FIXED_STANDARD" +], +"enumDescriptions": [ +"Public internet quality with fixed bandwidth.", +"High quality, Google-grade network tier, support for all networking\nproducts.", +"Public internet quality, only limited support for other networking\nproducts.", +"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured." +], +"type": "string" +}, "kind": { "default": "compute#subnetwork", "description": "Output only. [Output Only] Type of the resource. Always compute#subnetwork\nfor Subnetwork resources.", @@ -118009,6 +118526,10 @@ false "pathTemplateRewrite": { "description": "If specified, the pattern rewrites the URL path (based on the :path\nheader) using the HTTP template syntax. \n\nA corresponding\npath_template_match must be specified. Any template variables must exist in\nthe path_template_match field. \n \n \n - -At least one variable must be specified in the path_template_match\n field \n - You can omit variables from the rewritten URL\n - The * and ** operators cannot be matched\n unless they have a corresponding variable name - e.g.\n {format=*} or {var=**}.\n\nFor example, a path_template_match of /static/{format=**}\ncould be rewritten as /static/content/{format} to prefix/content to the URL. Variables can also be re-ordered in a\nrewrite, so that /{country}/{format}/{suffix=**} can be\nrewritten as /content/{format}/{country}/{suffix}. \n\nAt least\none non-empty routeRules[].matchRules[].path_template_match is\nrequired. \n\nOnly one of path_prefix_rewrite orpath_template_rewrite may be specified.", "type": "string" +}, +"regexRewrite": { +"$ref": "RegexRewrite", +"description": "The regex rewrite to be applied to the URL. Only one ofpathPrefixRewrite, pathTemplateRewrite, orregexRewrite may be specified." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index 98d8071bc3..774b8ef7d7 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -2201,7 +2201,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project.\nBackend services for external and internal passthrough Network Load\nBalancers are not included in the response.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -9475,6 +9475,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance deletion even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -9520,6 +9526,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance deletion even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -10058,6 +10070,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance recreation even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -10351,6 +10369,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance stopping even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -25047,7 +25071,7 @@ ] }, "listUsable": { -"description": "Retrieves a list of all usable backend services in the specified project in\nthe given region.", +"description": "Retrieves a list of all usable backend services for Application Load\nBalancers and Proxy Network Load Balancers in the specified project in the\ngiven region. Backend services for external and internal passthrough\nNetwork Load Balancers are not included in the response.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -28924,6 +28948,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance deletion even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -28969,6 +28999,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance deletion even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -29507,6 +29543,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance recreation even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -29801,6 +29843,12 @@ "required": true, "type": "string" }, +"noGracefulShutdown": { +"default": "false", +"description": "When set, graceful shutdown is skipped for instance stopping even if it's\nconfigured for the instances.", +"location": "query", +"type": "boolean" +}, "project": { "description": "Project ID for this request.", "location": "path", @@ -38418,6 +38466,58 @@ "https://www.googleapis.com/auth/compute" ] }, +"deleteNamedSet": { +"description": "Deletes Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteNamedSet", +"httpMethod": "POST", +"id": "compute.routers.deleteNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"namedSet": { +"description": "The Named Set name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Named Set is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/deleteNamedSet", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "deleteRoutePolicy": { "description": "Deletes Route Policy", "flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy", @@ -38513,6 +38613,53 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getNamedSet": { +"description": "Returns specified Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNamedSet", +"httpMethod": "GET", +"id": "compute.routers.getNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"namedSet": { +"description": "The Named Set name for this request. Name must conform to RFC1035", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"router": { +"description": "Name of the Router resource to query for the named set. The name should\nconform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/getNamedSet", +"response": { +"$ref": "RoutersGetNamedSetResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getNatIpInfo": { "description": "Retrieves runtime NAT IP information.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo", @@ -38950,6 +39097,77 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"listNamedSets": { +"description": "Retrieves a list of router named set subresources available to the\nspecified project.", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/listNamedSets", +"httpMethod": "GET", +"id": "compute.routers.listNamedSets", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.", +"location": "query", +"type": "boolean" +}, +"router": { +"description": "Name or id of the resource for this request.\nName should conform to RFC1035.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/listNamedSets", +"response": { +"$ref": "RoutersListNamedSets" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "listRoutePolicies": { "description": "Retrieves a list of router route policy subresources available to the\nspecified project.", "flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies", @@ -39071,6 +39289,56 @@ "https://www.googleapis.com/auth/compute" ] }, +"patchNamedSet": { +"description": "Patches Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchNamedSet", +"httpMethod": "POST", +"id": "compute.routers.patchNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Named Set is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/patchNamedSet", +"request": { +"$ref": "NamedSet" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "patchRoutePolicy": { "description": "Patches Route Policy", "flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy", @@ -39217,6 +39485,56 @@ "https://www.googleapis.com/auth/compute" ] }, +"updateNamedSet": { +"description": "Updates or creates new Named Set", +"flatPath": "projects/{project}/regions/{region}/routers/{router}/updateNamedSet", +"httpMethod": "POST", +"id": "compute.routers.updateNamedSet", +"parameterOrder": [ +"project", +"region", +"router" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"router": { +"description": "Name of the Router resource where Named Set is defined.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/routers/{router}/updateNamedSet", +"request": { +"$ref": "NamedSet" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "updateRoutePolicy": { "description": "Updates or creates new Route Policy", "flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy", @@ -47903,7 +48221,7 @@ } } }, -"revision": "20260625", +"revision": "20260629", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -48630,7 +48948,7 @@ false "type": "string" }, "ipCollection": { -"description": "Reference to the source of external IPv4 addresses,\nlike a PublicDelegatedPrefix (PDP) for BYOIP.\nThe PDP must support enhanced IPv4 allocations.\n\nUse one of the following formats to specify a PDP when reserving an\nexternal IPv4 address using BYOIP.\n \n - \n Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - \n Partial URL, as in\n \n \n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name", +"description": "Reference to the source of IP addresses.\n\nIt supports the following cases:\n \n - \n Case 1: PublicDelegatedPrefix (PDP) for BYOIP external IPv4\n addresses. The PDP must support enhanced IPv4 allocations.\n - \n Case 2: Internal Range for global internal addresses.\n\n\n\nUse one of the following formats to specify the resource:\n\nFor a Public Delegated Prefix:\n \n - \n Full resource URL:https://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp\n - Partial URL:\n - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n - regions/region/publicDelegatedPrefixes/pdp-name\n \n\n\nFor an Internal Range:\n \n - Full URL:https://networkconnectivity.googleapis.com/v1/projects/project/locations/global/internalRanges/internal-range\n - Partial URL:projects/project/locations/global/internalRanges/internal-range", "type": "string" }, "ipVersion": { @@ -58758,7 +59076,7 @@ false "id": "FirewallPolicyRule", "properties": { "action": { -"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\".\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", +"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\" (\n\"apply_security_profile_group\" can be specified only for global\nnetwork firewall policies or hierarchical firewall policies).\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".", "type": "string" }, "description": { @@ -58811,7 +59129,7 @@ false "type": "integer" }, "securityProfileGroup": { -"description": "A fully-qualified URL of a SecurityProfile resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions.", +"description": "A fully-qualified URL of a SecurityProfileGroup resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions. Can be specified only\nfor global network firewall policies or hierarchical firewall policies.", "type": "string" }, "targetForwardingRules": { @@ -65890,6 +66208,20 @@ false "readOnly": true, "type": "string" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "description": "Full or partial URL of the machine type resource to use for this instance,\nin the format:zones/zone/machineTypes/machine-type. This is provided by the client\nwhen the instance is created. For example, the following is a valid partial\nurl to a predefined\nmachine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo create acustom\nmachine type, provide a URL to a machine type in the following format,\nwhere CPUS is 1 or an even number up to 32 (2,\n4, 6, ... 24, etc), and MEMORY is the total\nmemory for this instance. Memory must be a multiple of 256 MB and must\nbe supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120\nFor a full list of restrictions, read theSpecifications\nfor custom machine types.", "type": "string" @@ -67455,6 +67787,13 @@ false "readOnly": true, "type": "string" }, +"instances": { +"description": "The names of instances to be created by this resize request. The number of\nnames specified determines the number of instances to create. The group's\ntarget size will be increased by this number. This field cannot be used\ntogether with 'resize_by'.", +"items": { +"$ref": "PerInstanceConfig" +}, +"type": "array" +}, "kind": { "default": "compute#instanceGroupManagerResizeRequest", "description": "Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests.", @@ -69727,6 +70066,20 @@ false "description": "Labels to apply to instances that are created from these properties.", "type": "object" }, +"localSsdEncryptionMode": { +"description": "Specifies which method should be used for encrypting the\nLocal SSDs attached to the VM.", +"enum": [ +"EPHEMERAL_KEY_ENCRYPTION", +"LOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED", +"STANDARD_ENCRYPTION" +], +"enumDescriptions": [ +"The given VM will opt-in for using ephemeral key for\nencryption of Local SSDs.\nThe Local SSDs will not be able to recover data in case of VM\ncrash.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted.", +"The given VM will be encrypted using keys managed by the cloud\ninfrastructure and the keys will be deleted when the VM is\ndeleted." +], +"type": "string" +}, "machineType": { "annotations": { "required": [ @@ -77225,6 +77578,16 @@ false "description": "Output only. [Output Only] Instance properties selected for this instance resulting from\nInstanceFlexibilityPolicy.", "readOnly": true }, +"scheduling": { +"$ref": "ManagedInstanceScheduling", +"description": "Output only. Information about the termination timestamp of the instance, if applicable.", +"readOnly": true +}, +"shutdownDetails": { +"$ref": "ManagedInstanceShutdownDetails", +"description": "Output only. Specifies the graceful shutdown details if the instance is in\n`PENDING_STOP` state or there is a programmed stop scheduled.", +"readOnly": true +}, "version": { "$ref": "ManagedInstanceVersion", "description": "Output only. [Output Only] Intended version of this instance.", @@ -77329,6 +77692,41 @@ false }, "type": "object" }, +"ManagedInstanceScheduling": { +"id": "ManagedInstanceScheduling", +"properties": { +"gracefulShutdownTimestamp": { +"description": "Output only. The timestamp at which the underlying instance will be\ntriggered for graceful shutdown if it is configured. This is in RFC3339 text format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"terminationTimestamp": { +"description": "Output only. The timestamp at which the managed instance will be terminated. This is\nin RFC3339 text\nformat.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ManagedInstanceShutdownDetails": { +"id": "ManagedInstanceShutdownDetails", +"properties": { +"maxDuration": { +"$ref": "Duration", +"description": "Output only. The duration for graceful shutdown. Only applicable when the instance is\nin `PENDING_STOP` state.", +"readOnly": true +}, +"requestTimestamp": { +"description": "Output only. Past timestamp indicating the beginning of `PENDING_STOP` state of\ninstance in RFC3339\ntext format.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ManagedInstanceVersion": { "id": "ManagedInstanceVersion", "properties": { @@ -77453,6 +77851,44 @@ false }, "type": "object" }, +"NamedSet": { +"id": "NamedSet", +"properties": { +"description": { +"description": "An optional description of named set.", +"type": "string" +}, +"elements": { +"description": "CEL expressions that are comparable to constructs of this set's type\n(see Policy Language).", +"items": { +"$ref": "Expr" +}, +"type": "array" +}, +"fingerprint": { +"description": "A fingerprint for the Named Set being applied to this Router, which is\nessentially a hash of the Named Set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes\nafter every request to modify or update the Named Set. You must always\nprovide an up-to-date fingerprint hash in order to update or change\nlabels.\n\nTo see the latest fingerprint, make a getNamedSet() request\nto retrieve a Named Set.", +"format": "byte", +"type": "string" +}, +"name": { +"description": "This set's name, which must be a resource ID segment and unique within all\nnamed sets owned by the Router. Name should conform to RFC1035.", +"type": "string" +}, +"type": { +"description": "This named set's type", +"enum": [ +"NAMED_SET_TYPE_COMMUNITY", +"NAMED_SET_TYPE_PREFIX" +], +"enumDescriptions": [ +"The Named Set is a Community Named Set.", +"The Named Set is a Prefix Named Set." +], +"type": "string" +} +}, +"type": "object" +}, "NatIpInfo": { "description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).", "id": "NatIpInfo", @@ -77710,14 +78146,14 @@ false "type": "string" }, "producerAcceptLists": { -"description": "Projects that are allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are allowed to connect to this network\nattachment. The project can be specified using its id or number. Service\nclass id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, "type": "array" }, "producerRejectLists": { -"description": "Projects that are not allowed to connect to this network attachment.\nThe project can be specified using its id or number.", +"description": "Projects or service class ids that are not allowed to connect to this\nnetwork attachment. The project can be specified using its id or number.\nService class id can be specified as \"serviceclasses/{service_class_id}\".", "items": { "type": "string" }, @@ -95519,6 +95955,19 @@ false }, "type": "object" }, +"RoutersGetNamedSetResponse": { +"id": "RoutersGetNamedSetResponse", +"properties": { +"etag": { +"description": "end_interface: MixerGetResponseWithEtagBuilder", +"type": "string" +}, +"resource": { +"$ref": "NamedSet" +} +}, +"type": "object" +}, "RoutersGetRoutePolicyResponse": { "id": "RoutersGetRoutePolicyResponse", "properties": { @@ -95695,6 +96144,173 @@ false }, "type": "object" }, +"RoutersListNamedSets": { +"id": "RoutersListNamedSets", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.", +"type": "string" +}, +"kind": { +"default": "compute#routersListNamedSets", +"description": "Output only. [Output Only] Type of resource. Alwayscompute#routersListNamedSets for lists of named sets.", +"readOnly": true, +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.", +"type": "string" +}, +"result": { +"description": "[Output Only] A list of named sets.", +"items": { +"$ref": "NamedSet" +}, +"type": "array" +}, +"selfLink": { +"description": "Output only. [Output Only] Server-defined URL for this resource.", +"readOnly": true, +"type": "string" +}, +"unreachables": { +"description": "Output only. [Output Only] Unreachable resources.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"QUOTA_INFO_UNAVAILABLE", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed\noperation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as\ndeprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as\nexperimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden.\nDeprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the\nnetwork.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite\nthe mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"Quota information is not available to client requests (e.g:\nregions.list).", +"The user attempted to use a resource that requires a TOS they have not\naccepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "RoutersListRoutePolicies": { "id": "RoutersListRoutePolicies", "properties": { @@ -100782,7 +101398,6 @@ false "id": "SslPolicyReference", "properties": { "sslPolicy": { -"description": "URL of the SSL policy resource. Set this to empty string to clear any\nexisting SSL policy associated with the target proxy resource.", "type": "string" } }, @@ -103075,6 +103690,23 @@ false "description": "The range of IP addresses belonging to this subnetwork secondary range.\nProvide this property when you create the subnetwork. Ranges must be\nunique and non-overlapping with all primary and secondary IP ranges\nwithin a network. Both IPv4 and IPv6 ranges are supported. For IPv4,\nthe range can be any range listed in theValid\nranges list.\n\nFor IPv6:\nThe range must have a /64 prefix length.\nThe range must be omitted, for auto-allocation from Google-defined ULA\nIPv6 range.\nFor BYOGUA internal IPv6 secondary range, the range may be specified\nalong with the `ipCollection` field.\nIf an `ipCollection` is specified, the requested ip_cidr_range must lie\nwithin the range of the PDP referenced by the `ipCollection` field for\nallocation.\nIf `ipCollection` field is specified, but ip_cidr_range is not,\nthe range is auto-allocated from the PDP referenced by the `ipCollection`\nfield.", "type": "string" }, +"ipCollection": { +"description": "Reference to a Public Delegated Prefix (PDP) for BYOIP.\nThis field should be specified for configuring BYOGUA internal IPv6\nsecondary range.\nWhen specified along with the ip_cidr_range, the ip_cidr_range must lie\nwithin the PDP referenced by the `ipCollection` field.\nWhen specified without the ip_cidr_range, the range is auto-allocated\nfrom the PDP referenced by the `ipCollection` field.", +"type": "string" +}, +"ipVersion": { +"enum": [ +"IPV4", +"IPV6", +"IP_VERSION_UNSPECIFIED" +], +"enumDescriptions": [ +"", +"", +"Treated as IPV4 for backward-compatibility." +], +"type": "string" +}, "rangeName": { "description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP/IPv6 range to a VM instance.\nThe name must be 1-63 characters long, and comply withRFC1035.\nThe name must be unique within the subnetwork.", "type": "string" From c31ce681d8e1a3f7b428cafddd74866519bffd83 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:51 +0000 Subject: [PATCH 22/50] feat(config): update the api #### config:v1 The following keys were added: - schemas.DeploymentOperationMetadata.properties.applyResultsAvailable (Total Keys: 2) --- googleapiclient/discovery_cache/documents/config.v1.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index eb774a5082..d8c9cf2d03 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1788,7 +1788,7 @@ } } }, -"revision": "20260610", +"revision": "20260623", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -2262,6 +2262,11 @@ "$ref": "ApplyResults", "description": "Outputs and artifacts from applying a deployment." }, +"applyResultsAvailable": { +"description": "Output only. Indicating if early apply results are available.", +"readOnly": true, +"type": "boolean" +}, "build": { "description": "Output only. Cloud Build instance UUID associated with this operation.", "readOnly": true, From feac67543fccaf7412ad0f5744c3ea46a5c490fd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:51 +0000 Subject: [PATCH 23/50] feat(container): update the api #### container:v1 The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.completeControlPlaneUpgrade (Total Keys: 12) - resources.projects.resources.zones.resources.clusters.methods.completeControlPlaneUpgrade (Total Keys: 12) - schemas.Cluster.properties.currentEmulatedVersion (Total Keys: 2) - schemas.Cluster.properties.rollbackSafeUpgrade.$ref (Total Keys: 1) - schemas.ClusterUpdate.properties.desiredEmulatedVersion.type (Total Keys: 1) - schemas.ClusterUpdate.properties.desiredRollbackSafeUpgrade.$ref (Total Keys: 1) - schemas.ClusterUpgradeInfo.properties.rollbackSafeUpgradeStatus (Total Keys: 2) - schemas.CompleteControlPlaneUpgradeRequest (Total Keys: 3) - schemas.DiskIoScheduler (Total Keys: 4) - schemas.KubeletCertInfo (Total Keys: 8) - schemas.LinuxNodeConfig.properties.diskIoScheduler.$ref (Total Keys: 1) - schemas.LinuxNodeConfig.properties.nodeVfioConfig.$ref (Total Keys: 1) - schemas.NodePool.properties.kubeletCertInfo (Total Keys: 2) - schemas.NodeVfioConfig (Total Keys: 4) - schemas.RollbackSafeUpgrade (Total Keys: 13) - schemas.UpgradeDetails.properties.initialEmulatedVersion (Total Keys: 2) - schemas.UpgradeDetails.properties.targetEmulatedVersion (Total Keys: 2) - schemas.UpgradeEvent.properties.currentEmulatedVersion (Total Keys: 2) - schemas.UpgradeEvent.properties.targetEmulatedVersion (Total Keys: 2) - schemas.UpgradeInfoEvent.properties.currentEmulatedVersion (Total Keys: 2) - schemas.UpgradeInfoEvent.properties.targetEmulatedVersion (Total Keys: 2) #### container:v1beta1 The following keys were added: - schemas.ClusterUpdate.properties.desiredEmulatedVersion.type (Total Keys: 1) - schemas.DiskIoScheduler (Total Keys: 4) - schemas.KubeletCertInfo (Total Keys: 8) - schemas.LinuxNodeConfig.properties.diskIoScheduler.$ref (Total Keys: 1) - schemas.LinuxNodeConfig.properties.nodeVfioConfig.$ref (Total Keys: 1) - schemas.NodePool.properties.kubeletCertInfo (Total Keys: 2) - schemas.NodeVfioConfig (Total Keys: 4) --- ...tainer_v1.projects.locations.clusters.html | 230 ++++++++++++++++-- ...projects.locations.clusters.nodePools.html | 58 ++++- .../container_v1.projects.zones.clusters.html | 230 ++++++++++++++++-- ..._v1.projects.zones.clusters.nodePools.html | 58 ++++- ...r_v1beta1.projects.locations.clusters.html | 131 ++++++++-- ...projects.locations.clusters.nodePools.html | 56 ++++- ...ainer_v1beta1.projects.zones.clusters.html | 131 ++++++++-- ...ta1.projects.zones.clusters.nodePools.html | 56 ++++- .../documents/container.v1.json | 229 ++++++++++++++++- .../documents/container.v1beta1.json | 69 +++++- 10 files changed, 1114 insertions(+), 134 deletions(-) diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index e59de56fb5..cc330fe202 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -90,6 +90,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ completeControlPlaneUpgrade(name, body=None, x__xgafv=None)

+

CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.

completeIpRotation(name, body=None, x__xgafv=None)

Completes master IP rotation.

@@ -184,6 +187,80 @@

Method Details

Close httplib2 connections.
+
+ completeControlPlaneUpgrade(name, body=None, x__xgafv=None) +
CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.
+
+Args:
+  name: string, Required. The name (project, location, cluster) of the cluster to complete upgrade. Specified in the format `projects/*/locations/*/clusters/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # CompleteControlPlaneUpgradeRequest sets the name of target cluster to complete upgrade.
+  "version": "A String", # Optional. API request version that initiates this operation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
+  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
+    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
+      "canonicalCode": "A String", # Canonical code of the condition.
+      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
+      "message": "A String", # Human-friendly representation of the condition
+    },
+  ],
+  "detail": "A String", # Output only. Detailed operation progress, if available.
+  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "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.
+    "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.
+  },
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "name": "A String", # Output only. The server-assigned ID for the operation.
+  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
+    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
+      "canonicalCode": "A String", # Canonical code of the condition.
+      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
+      "message": "A String", # Human-friendly representation of the condition
+    },
+  ],
+  "operationType": "A String", # Output only. The operation type.
+  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
+    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
+      { # Progress metric is (string, int|float|string) pair.
+        "doubleValue": 3.14, # For metrics with floating point value.
+        "intValue": "A String", # For metrics with integer value.
+        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
+        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
+      },
+    ],
+    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
+    "stages": [ # Substages of an operation or a stage.
+      # Object with schema name: OperationProgress
+    ],
+    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
+  },
+  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "status": "A String", # Output only. The current status of the operation.
+  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
+  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+}
+
+
completeIpRotation(name, body=None, x__xgafv=None)
Completes master IP rotation.
@@ -490,6 +567,7 @@ 

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -910,7 +988,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -933,6 +1011,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -940,6 +1022,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -957,7 +1042,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1075,6 +1160,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1082,6 +1171,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1099,7 +1191,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1160,7 +1252,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1287,7 +1379,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1479,7 +1571,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1502,6 +1594,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1509,6 +1605,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1526,7 +1625,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1629,6 +1728,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1786,6 +1889,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -2005,13 +2111,20 @@

Method Details

"pausedReason": [ # The auto upgrade paused reason. "A String", ], + "rollbackSafeUpgradeStatus": { # RollbackSafeUpgradeStatus contains the rollback-safe upgrade status of a cluster. # Output only. The cluster's rollback-safe upgrade status. + "controlPlaneUpgradeRollbackEndTime": "A String", # Output only. The rollback-safe mode expiration time. + "mode": "A String", # Output only. The mode of the rollback-safe upgrade. + "previousVersion": "A String", # Output only. The GKE version that the cluster previously used before step-one upgrade. + }, "upgradeDetails": [ # The list of past auto upgrades. { # UpgradeDetails contains detailed information of each individual upgrade operation. "endTime": "A String", # The end timestamp of the upgrade. + "initialEmulatedVersion": "A String", # Output only. The emulated version before the upgrade. "initialVersion": "A String", # The version before the upgrade. "startTime": "A String", # The start timestamp of the upgrade. "startType": "A String", # The start type of the upgrade. "state": "A String", # Output only. The state of the upgrade. + "targetEmulatedVersion": "A String", # Output only. The emulated version after the upgrade. "targetVersion": "A String", # The version after the upgrade. }, ], @@ -2254,6 +2367,7 @@

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -2674,7 +2788,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2697,6 +2811,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2704,6 +2822,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2721,7 +2842,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2839,6 +2960,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2846,6 +2971,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2863,7 +2991,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2924,7 +3052,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3051,7 +3179,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3243,7 +3371,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3266,6 +3394,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3273,6 +3405,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3290,7 +3425,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3393,6 +3528,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -3550,6 +3689,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -3882,6 +4024,7 @@

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -4302,7 +4445,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4325,6 +4468,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4332,6 +4479,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4349,7 +4499,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4467,6 +4617,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4474,6 +4628,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4491,7 +4648,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4552,7 +4709,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4679,7 +4836,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4871,7 +5028,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4894,6 +5051,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4901,6 +5062,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4918,7 +5082,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5021,6 +5185,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -5178,6 +5346,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -6479,6 +6650,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, + "desiredEmulatedVersion": "A String", # Optional. The desired emulated version for the cluster. "desiredEnableCiliumClusterwideNetworkPolicy": True or False, # Enable/Disable Cilium Clusterwide Network Policy for the cluster. "desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster @@ -6626,7 +6798,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -6681,7 +6853,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -6701,6 +6873,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -6708,6 +6884,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -6725,7 +6904,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -6811,6 +6990,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredRollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The desired rollback safe upgrade configuration. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. "enabled": True or False, # Enable/Disable Secret Manager Config. "rotationConfig": { # RotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index 5ebe37aad0..c289b2e2f1 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -335,7 +335,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -358,6 +358,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -365,6 +369,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -382,7 +389,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -485,6 +492,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -759,10 +770,12 @@

Method Details

"upgradeDetails": [ # The list of past auto upgrades. { # UpgradeDetails contains detailed information of each individual upgrade operation. "endTime": "A String", # The end timestamp of the upgrade. + "initialEmulatedVersion": "A String", # Output only. The emulated version before the upgrade. "initialVersion": "A String", # The version before the upgrade. "startTime": "A String", # The start timestamp of the upgrade. "startType": "A String", # The start type of the upgrade. "state": "A String", # Output only. The state of the upgrade. + "targetEmulatedVersion": "A String", # Output only. The emulated version after the upgrade. "targetVersion": "A String", # The version after the upgrade. }, ], @@ -971,7 +984,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -994,6 +1007,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1001,6 +1018,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1018,7 +1038,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1121,6 +1141,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1431,7 +1455,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1454,6 +1478,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1461,6 +1489,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1478,7 +1509,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1581,6 +1612,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -2179,7 +2214,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2204,6 +2239,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2211,6 +2250,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2228,7 +2270,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index c5b5df13e3..60592692f1 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -85,6 +85,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ completeControlPlaneUpgrade(name, body=None, x__xgafv=None)

+

CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.

completeIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)

Completes master IP rotation.

@@ -295,6 +298,80 @@

Method Details

Close httplib2 connections.
+
+ completeControlPlaneUpgrade(name, body=None, x__xgafv=None) +
CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.
+
+Args:
+  name: string, Required. The name (project, location, cluster) of the cluster to complete upgrade. Specified in the format `projects/*/locations/*/clusters/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # CompleteControlPlaneUpgradeRequest sets the name of target cluster to complete upgrade.
+  "version": "A String", # Optional. API request version that initiates this operation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
+  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
+    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
+      "canonicalCode": "A String", # Canonical code of the condition.
+      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
+      "message": "A String", # Human-friendly representation of the condition
+    },
+  ],
+  "detail": "A String", # Output only. Detailed operation progress, if available.
+  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "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.
+    "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.
+  },
+  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+  "name": "A String", # Output only. The server-assigned ID for the operation.
+  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
+    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
+      "canonicalCode": "A String", # Canonical code of the condition.
+      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
+      "message": "A String", # Human-friendly representation of the condition
+    },
+  ],
+  "operationType": "A String", # Output only. The operation type.
+  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
+    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
+      { # Progress metric is (string, int|float|string) pair.
+        "doubleValue": 3.14, # For metrics with floating point value.
+        "intValue": "A String", # For metrics with integer value.
+        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
+        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
+      },
+    ],
+    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
+    "stages": [ # Substages of an operation or a stage.
+      # Object with schema name: OperationProgress
+    ],
+    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
+  },
+  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+  "status": "A String", # Output only. The current status of the operation.
+  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
+  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+}
+
+
completeIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)
Completes master IP rotation.
@@ -604,6 +681,7 @@ 

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -1024,7 +1102,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1047,6 +1125,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1054,6 +1136,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1071,7 +1156,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1189,6 +1274,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1196,6 +1285,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1213,7 +1305,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1274,7 +1366,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1401,7 +1493,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1593,7 +1685,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1616,6 +1708,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1623,6 +1719,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1640,7 +1739,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1743,6 +1842,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1900,6 +2003,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -2119,13 +2225,20 @@

Method Details

"pausedReason": [ # The auto upgrade paused reason. "A String", ], + "rollbackSafeUpgradeStatus": { # RollbackSafeUpgradeStatus contains the rollback-safe upgrade status of a cluster. # Output only. The cluster's rollback-safe upgrade status. + "controlPlaneUpgradeRollbackEndTime": "A String", # Output only. The rollback-safe mode expiration time. + "mode": "A String", # Output only. The mode of the rollback-safe upgrade. + "previousVersion": "A String", # Output only. The GKE version that the cluster previously used before step-one upgrade. + }, "upgradeDetails": [ # The list of past auto upgrades. { # UpgradeDetails contains detailed information of each individual upgrade operation. "endTime": "A String", # The end timestamp of the upgrade. + "initialEmulatedVersion": "A String", # Output only. The emulated version before the upgrade. "initialVersion": "A String", # The version before the upgrade. "startTime": "A String", # The start timestamp of the upgrade. "startType": "A String", # The start type of the upgrade. "state": "A String", # Output only. The state of the upgrade. + "targetEmulatedVersion": "A String", # Output only. The emulated version after the upgrade. "targetVersion": "A String", # The version after the upgrade. }, ], @@ -2368,6 +2481,7 @@

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -2788,7 +2902,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2811,6 +2925,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2818,6 +2936,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2835,7 +2956,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -2953,6 +3074,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2960,6 +3085,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2977,7 +3105,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3038,7 +3166,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3165,7 +3293,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3357,7 +3485,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3380,6 +3508,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3387,6 +3519,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3404,7 +3539,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3507,6 +3642,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -3664,6 +3803,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -4040,6 +4182,7 @@

Method Details

"enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentEmulatedVersion": "A String", # Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version. "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. @@ -4460,7 +4603,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4483,6 +4626,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4490,6 +4637,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4507,7 +4657,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4625,6 +4775,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4632,6 +4786,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4649,7 +4806,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4710,7 +4867,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4837,7 +4994,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5029,7 +5186,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5052,6 +5209,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -5059,6 +5220,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -5076,7 +5240,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5179,6 +5343,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -5336,6 +5504,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "rollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleUpgradeConfig": { # Configuration for scheduled upgrades on the cluster. # Optional. Configuration for scheduled upgrades. @@ -6506,6 +6677,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, + "desiredEmulatedVersion": "A String", # Optional. The desired emulated version for the cluster. "desiredEnableCiliumClusterwideNetworkPolicy": True or False, # Enable/Disable Cilium Clusterwide Network Policy for the cluster. "desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster @@ -6653,7 +6825,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -6708,7 +6880,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -6728,6 +6900,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -6735,6 +6911,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -6752,7 +6931,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -6838,6 +7017,9 @@

Method Details

}, "enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic. }, + "desiredRollbackSafeUpgrade": { # RollbackSafeUpgrade is the configuration for the rollback safe upgrade. # Optional. The desired rollback safe upgrade configuration. + "controlPlaneSoakDuration": "A String", # Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}. + }, "desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config. "enabled": True or False, # Enable/Disable Secret Manager Config. "rotationConfig": { # RotationConfig is config for secret manager auto rotation. # Rotation config for secret manager. diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index e71bbc855b..cc97bbfdb4 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -400,7 +400,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -423,6 +423,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -430,6 +434,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -447,7 +454,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -550,6 +557,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -824,10 +835,12 @@

Method Details

"upgradeDetails": [ # The list of past auto upgrades. { # UpgradeDetails contains detailed information of each individual upgrade operation. "endTime": "A String", # The end timestamp of the upgrade. + "initialEmulatedVersion": "A String", # Output only. The emulated version before the upgrade. "initialVersion": "A String", # The version before the upgrade. "startTime": "A String", # The start timestamp of the upgrade. "startType": "A String", # The start type of the upgrade. "state": "A String", # Output only. The state of the upgrade. + "targetEmulatedVersion": "A String", # Output only. The emulated version after the upgrade. "targetVersion": "A String", # The version after the upgrade. }, ], @@ -1036,7 +1049,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1059,6 +1072,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1066,6 +1083,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1083,7 +1103,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1186,6 +1206,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1496,7 +1520,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1519,6 +1543,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1526,6 +1554,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1543,7 +1574,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1646,6 +1677,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -2169,7 +2204,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2194,6 +2229,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2201,6 +2240,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2218,7 +2260,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 0b21559c35..7f3cd7f70a 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -1026,7 +1026,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1049,6 +1049,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1056,6 +1060,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1073,7 +1080,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1193,6 +1200,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1200,6 +1211,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1217,7 +1231,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1278,7 +1292,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1413,7 +1427,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1620,7 +1634,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1643,6 +1657,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1650,6 +1668,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1667,7 +1688,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1772,6 +1793,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -2890,7 +2915,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2913,6 +2938,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2920,6 +2949,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2937,7 +2969,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3057,6 +3089,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3064,6 +3100,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3081,7 +3120,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3142,7 +3181,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3277,7 +3316,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3484,7 +3523,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3507,6 +3546,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3514,6 +3557,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3531,7 +3577,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3636,6 +3682,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -4611,7 +4661,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4634,6 +4684,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4641,6 +4695,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4658,7 +4715,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4778,6 +4835,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4785,6 +4846,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4802,7 +4866,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4863,7 +4927,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4998,7 +5062,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5205,7 +5269,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5228,6 +5292,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -5235,6 +5303,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -5252,7 +5323,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5357,6 +5428,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -6864,6 +6939,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, + "desiredEmulatedVersion": "A String", # Optional. The desired emulated version for the cluster. "desiredEnableCiliumClusterwideNetworkPolicy": True or False, # Enable/Disable Cilium Clusterwide Network Policy for the cluster. "desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster @@ -7025,7 +7101,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -7080,7 +7156,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -7100,6 +7176,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -7107,6 +7187,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -7124,7 +7207,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index bf9397d226..4a24bd2e1f 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -347,7 +347,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -370,6 +370,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -377,6 +381,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -394,7 +401,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -499,6 +506,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1000,7 +1011,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1023,6 +1034,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1030,6 +1045,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1047,7 +1065,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1152,6 +1170,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1475,7 +1497,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1498,6 +1520,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1505,6 +1531,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1522,7 +1551,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1627,6 +1656,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -2227,7 +2260,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2252,6 +2285,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2259,6 +2296,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2276,7 +2316,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index c628b3f195..f360a2384d 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -1147,7 +1147,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1170,6 +1170,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1177,6 +1181,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1194,7 +1201,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1314,6 +1321,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1321,6 +1332,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1338,7 +1352,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1399,7 +1413,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1534,7 +1548,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1741,7 +1755,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1764,6 +1778,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1771,6 +1789,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1788,7 +1809,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1893,6 +1914,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -3011,7 +3036,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3034,6 +3059,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3041,6 +3070,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3058,7 +3090,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3178,6 +3210,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3185,6 +3221,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3202,7 +3241,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3263,7 +3302,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3398,7 +3437,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3605,7 +3644,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -3628,6 +3667,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -3635,6 +3678,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -3652,7 +3698,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -3757,6 +3803,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -4776,7 +4826,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -4799,6 +4849,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4806,6 +4860,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4823,7 +4880,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -4943,6 +5000,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -4950,6 +5011,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -4967,7 +5031,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5028,7 +5092,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5163,7 +5227,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5370,7 +5434,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -5393,6 +5457,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -5400,6 +5468,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -5417,7 +5488,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -5522,6 +5593,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -6891,6 +6966,7 @@

Method Details

"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records. "clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records. }, + "desiredEmulatedVersion": "A String", # Optional. The desired emulated version for the cluster. "desiredEnableCiliumClusterwideNetworkPolicy": True or False, # Enable/Disable Cilium Clusterwide Network Policy for the cluster. "desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster. "desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster @@ -7052,7 +7128,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -7107,7 +7183,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -7127,6 +7203,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -7134,6 +7214,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -7151,7 +7234,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index 9e27a20b97..1f770fdbab 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -412,7 +412,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -435,6 +435,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -442,6 +446,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -459,7 +466,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -564,6 +571,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1065,7 +1076,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1088,6 +1099,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1095,6 +1110,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1112,7 +1130,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1217,6 +1235,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -1540,7 +1562,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -1563,6 +1585,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -1570,6 +1596,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -1587,7 +1616,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. @@ -1692,6 +1721,10 @@

Method Details

"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], + "kubeletCertInfo": { # Contains expiry information about the kubelet certificate. # Output only. Contains expiry information about the kubelet certificate. + "nonTpmBootstrapCertExpireTime": "A String", # Output only. + "tpmBootstrapCertExpireTime": "A String", # Output only. + }, "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. "A String", ], @@ -2217,7 +2250,7 @@

Method Details

"shutdownGracePeriodCriticalPodsSeconds": 42, # Optional. shutdown_grace_period_critical_pods_seconds is the maximum allowed grace period (in seconds) used to terminate critical pods during a node shutdown. This value should be <= shutdown_grace_period_seconds, and is only valid if shutdown_grace_period_seconds is set. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ Range: [0, 120]. "shutdownGracePeriodSeconds": 42, # Optional. shutdown_grace_period_seconds is the maximum allowed grace period (in seconds) the total duration that the node should delay the shutdown during a graceful shutdown. This is the total grace period for pod termination for both regular and critical pods. https://kubernetes.io/docs/concepts/cluster-administration/node-shutdown/ If set to 0, node will not enable the graceful node shutdown functionality. This field is only valid for Spot VMs. Allowed values: 0, 30, 120. "singleProcessOomKill": True or False, # Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group. - "topologyManager": { # TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ + "topologyManager": { # TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers). # Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/ "policy": "A String", # Configures the strategy for resource alignment. Allowed values are: * none: the default policy, and does not perform any topology alignment. * restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. * best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. * single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found [here](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-policies). "scope": "A String", # The Topology Manager aligns resources in following scopes: * container * pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes }, @@ -2242,6 +2275,10 @@

Method Details

"gcsUri": "A String", # The Cloud Storage URI for storing the init script. Format: gs://BUCKET_NAME/OBJECT_NAME The service account on the node pool must have read access to the object. User can't configure both gcs_uri and gcp_secret_manager_secret_uri. }, }, + "diskIoScheduler": { # DiskIoScheduler contains the configuration for the disk IO scheduler. # Optional. Controls the configuration for the disk IO scheduler. + "nodeAttachedDiskIoScheduler": "A String", # Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + "nodeSystemIoScheduler": "A String", # Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`. + }, "hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages "hugepageSize1g": 42, # Optional. Amount of 1G hugepages "hugepageSize2m": 42, # Optional. Amount of 2M hugepages @@ -2249,6 +2286,9 @@

Method Details

"nodeKernelModuleLoading": { # Configuration for kernel module loading on nodes. # Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification. "policy": "A String", # Set the node module loading policy for nodes in the node pool. }, + "nodeVfioConfig": { # Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices. # Optional. Contains VFIO-related configurations for this node. + "dmaEntryLimit": 42, # Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`. + }, "swapConfig": { # Configuration for swap memory on a node pool. # Optional. Enables and configures swap space on nodes. If omitted, swap is disabled. "bootDiskProfile": { # Swap on the node's boot disk. # Swap on the node's boot disk. "swapSizeGib": "A String", # Specifies the size of the swap space in gibibytes (GiB). @@ -2266,7 +2306,7 @@

Method Details

"swapSizePercent": 42, # Specifies the size of the swap space as a percentage of the ephemeral local SSD capacity. }, }, - "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes + "sysctls": { # The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes "a_key": "A String", }, "transparentHugepageDefrag": "A String", # Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details. diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index aed8e042db..4d7cb2c7ee 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -236,6 +236,35 @@ "https://www.googleapis.com/auth/container.read-only" ] }, +"completeControlPlaneUpgrade": { +"description": "CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeControlPlaneUpgrade", +"httpMethod": "POST", +"id": "container.projects.locations.clusters.completeControlPlaneUpgrade", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster) of the cluster to complete upgrade. Specified in the format `projects/*/locations/*/clusters/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:completeControlPlaneUpgrade", +"request": { +"$ref": "CompleteControlPlaneUpgradeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" +] +}, "completeIpRotation": { "description": "Completes master IP rotation.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation", @@ -1445,6 +1474,35 @@ "https://www.googleapis.com/auth/container" ] }, +"completeControlPlaneUpgrade": { +"description": "CompleteControlPlaneUpgrade completes the rollback-safe upgrade by performing the step two upgrade for a specific cluster.", +"flatPath": "v1/projects/{projectsId}/zones/{zonesId}/clusters/{clustersId}:completeControlPlaneUpgrade", +"httpMethod": "POST", +"id": "container.projects.zones.clusters.completeControlPlaneUpgrade", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name (project, location, cluster) of the cluster to complete upgrade. Specified in the format `projects/*/locations/*/clusters/*`.", +"location": "path", +"pattern": "^projects/[^/]+/zones/[^/]+/clusters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:completeControlPlaneUpgrade", +"request": { +"$ref": "CompleteControlPlaneUpgradeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/container" +] +}, "completeIpRotation": { "description": "Completes master IP rotation.", "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", @@ -2753,7 +2811,7 @@ } } }, -"revision": "20260616", +"revision": "20260630", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3667,6 +3725,11 @@ "readOnly": true, "type": "string" }, +"currentEmulatedVersion": { +"description": "Output only. The current emulated version of the master endpoint. The version is in minor version format, e.g. 1.30. No value or empty string means the cluster has no emulated version.", +"readOnly": true, +"type": "string" +}, "currentMasterVersion": { "description": "Output only. The current software version of the master endpoint.", "readOnly": true, @@ -3911,6 +3974,10 @@ "$ref": "ResourceUsageExportConfig", "description": "Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified." }, +"rollbackSafeUpgrade": { +"$ref": "RollbackSafeUpgrade", +"description": "Optional. The rollback safe upgrade information of the cluster. This field is used when user manually triggers a rollback safe upgrade." +}, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -4213,6 +4280,10 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, +"desiredEmulatedVersion": { +"description": "Optional. The desired emulated version for the cluster.", +"type": "string" +}, "desiredEnableCiliumClusterwideNetworkPolicy": { "description": "Enable/Disable Cilium Clusterwide Network Policy for the cluster.", "type": "boolean" @@ -4430,6 +4501,10 @@ "$ref": "ResourceUsageExportConfig", "description": "The desired configuration for exporting resource usage." }, +"desiredRollbackSafeUpgrade": { +"$ref": "RollbackSafeUpgrade", +"description": "Optional. The desired rollback safe upgrade configuration." +}, "desiredSecretManagerConfig": { "$ref": "SecretManagerConfig", "description": "Enable/Disable Secret Manager Config." @@ -4564,6 +4639,11 @@ }, "type": "array" }, +"rollbackSafeUpgradeStatus": { +"$ref": "RollbackSafeUpgradeStatus", +"description": "Output only. The cluster's rollback-safe upgrade status.", +"readOnly": true +}, "upgradeDetails": { "description": "The list of past auto upgrades.", "items": { @@ -4574,6 +4654,17 @@ }, "type": "object" }, +"CompleteControlPlaneUpgradeRequest": { +"description": "CompleteControlPlaneUpgradeRequest sets the name of target cluster to complete upgrade.", +"id": "CompleteControlPlaneUpgradeRequest", +"properties": { +"version": { +"description": "Optional. API request version that initiates this operation.", +"type": "string" +} +}, +"type": "object" +}, "CompleteIPRotationRequest": { "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", "id": "CompleteIPRotationRequest", @@ -5138,6 +5229,21 @@ }, "type": "object" }, +"DiskIoScheduler": { +"description": "DiskIoScheduler contains the configuration for the disk IO scheduler.", +"id": "DiskIoScheduler", +"properties": { +"nodeAttachedDiskIoScheduler": { +"description": "Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`.", +"type": "string" +}, +"nodeSystemIoScheduler": { +"description": "Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`.", +"type": "string" +} +}, +"type": "object" +}, "DisruptionBudget": { "description": "DisruptionBudget defines the upgrade disruption budget for the cluster control plane.", "id": "DisruptionBudget", @@ -6161,6 +6267,25 @@ false }, "type": "object" }, +"KubeletCertInfo": { +"description": "Contains expiry information about the kubelet certificate.", +"id": "KubeletCertInfo", +"properties": { +"nonTpmBootstrapCertExpireTime": { +"description": "Output only.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"tpmBootstrapCertExpireTime": { +"description": "Output only.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "KubernetesDashboard": { "description": "Configuration for the Kubernetes Dashboard.", "id": "KubernetesDashboard", @@ -6209,6 +6334,10 @@ false "$ref": "CustomNodeInit", "description": "Optional. Allow users to run arbitrary bash script or container on the node." }, +"diskIoScheduler": { +"$ref": "DiskIoScheduler", +"description": "Optional. Controls the configuration for the disk IO scheduler." +}, "hugepages": { "$ref": "HugepagesConfig", "description": "Optional. Amounts for 2M and 1G hugepages" @@ -6217,6 +6346,10 @@ false "$ref": "NodeKernelModuleLoading", "description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification." }, +"nodeVfioConfig": { +"$ref": "NodeVfioConfig", +"description": "Optional. Contains VFIO-related configurations for this node." +}, "swapConfig": { "$ref": "SwapConfig", "description": "Optional. Enables and configures swap space on nodes. If omitted, swap is disabled." @@ -6225,7 +6358,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", +"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", "type": "object" }, "transparentHugepageDefrag": { @@ -7589,6 +7722,11 @@ false "readOnly": true, "type": "array" }, +"kubeletCertInfo": { +"$ref": "KubeletCertInfo", +"description": "Output only. Contains expiry information about the kubelet certificate.", +"readOnly": true +}, "locations": { "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "items": { @@ -7921,6 +8059,18 @@ false }, "type": "object" }, +"NodeVfioConfig": { +"description": "Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices.", +"id": "NodeVfioConfig", +"properties": { +"dmaEntryLimit": { +"description": "Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "NotificationConfig": { "description": "NotificationConfig is the configuration of notifications.", "id": "NotificationConfig", @@ -8763,6 +8913,49 @@ false }, "type": "object" }, +"RollbackSafeUpgrade": { +"description": "RollbackSafeUpgrade is the configuration for the rollback safe upgrade.", +"id": "RollbackSafeUpgrade", +"properties": { +"controlPlaneSoakDuration": { +"description": "Optional. A user-defined period for the cluster remains in the rollbackable state. ex: {seconds: 21600}.", +"format": "google-duration", +"type": "string" +} +}, +"type": "object" +}, +"RollbackSafeUpgradeStatus": { +"description": "RollbackSafeUpgradeStatus contains the rollback-safe upgrade status of a cluster.", +"id": "RollbackSafeUpgradeStatus", +"properties": { +"controlPlaneUpgradeRollbackEndTime": { +"description": "Output only. The rollback-safe mode expiration time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"mode": { +"description": "Output only. The mode of the rollback-safe upgrade.", +"enum": [ +"MODE_UNSPECIFIED", +"KCP_MINOR_UPGRADE_ROLLBACK_SAFE_MODE" +], +"enumDescriptions": [ +"MODE_UNSPECIFIED means it's in regular upgrade mode.", +"KCP_MINOR_UPGRADE_ROLLBACK_SAFE_MODE means it's in rollback-safe mode after a KCP minor version step-one upgrade." +], +"readOnly": true, +"type": "string" +}, +"previousVersion": { +"description": "Output only. The GKE version that the cluster previously used before step-one upgrade.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RotationConfig": { "description": "RotationConfig is config for secret manager auto rotation.", "id": "RotationConfig", @@ -9785,7 +9978,7 @@ false "type": "object" }, "TopologyManager": { -"description": "TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/", +"description": "TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers).", "id": "TopologyManager", "properties": { "policy": { @@ -10099,6 +10292,11 @@ false "format": "google-datetime", "type": "string" }, +"initialEmulatedVersion": { +"description": "Output only. The emulated version before the upgrade.", +"readOnly": true, +"type": "string" +}, "initialVersion": { "description": "The version before the upgrade.", "type": "string" @@ -10141,6 +10339,11 @@ false "readOnly": true, "type": "string" }, +"targetEmulatedVersion": { +"description": "Output only. The emulated version after the upgrade.", +"readOnly": true, +"type": "string" +}, "targetVersion": { "description": "The version after the upgrade.", "type": "string" @@ -10152,6 +10355,11 @@ false "description": "UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.", "id": "UpgradeEvent", "properties": { +"currentEmulatedVersion": { +"description": "Output only. The current emulated version before the upgrade.", +"readOnly": true, +"type": "string" +}, "currentVersion": { "description": "The current version before the upgrade.", "type": "string" @@ -10183,6 +10391,11 @@ false ], "type": "string" }, +"targetEmulatedVersion": { +"description": "Output only. The target emulated version for the upgrade.", +"readOnly": true, +"type": "string" +}, "targetVersion": { "description": "The target version for the upgrade.", "type": "string" @@ -10194,6 +10407,11 @@ false "description": "UpgradeInfoEvent is a notification sent to customers about the upgrade information of a resource.", "id": "UpgradeInfoEvent", "properties": { +"currentEmulatedVersion": { +"description": "Output only. The current emulated version before the upgrade.", +"readOnly": true, +"type": "string" +}, "currentVersion": { "description": "The current version before the upgrade.", "type": "string" @@ -10287,6 +10505,11 @@ false "readOnly": true, "type": "string" }, +"targetEmulatedVersion": { +"description": "Output only. The target emulated version for the upgrade.", +"readOnly": true, +"type": "string" +}, "targetVersion": { "description": "The target version for the upgrade.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 50a7f06541..40bcf451c0 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2837,7 +2837,7 @@ } } }, -"revision": "20260616", +"revision": "20260630", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4447,6 +4447,10 @@ "$ref": "DNSConfig", "description": "DNSConfig contains clusterDNS config for this cluster." }, +"desiredEmulatedVersion": { +"description": "Optional. The desired emulated version for the cluster.", +"type": "string" +}, "desiredEnableCiliumClusterwideNetworkPolicy": { "description": "Enable/Disable Cilium Clusterwide Network Policy for the cluster.", "type": "boolean" @@ -5452,6 +5456,21 @@ }, "type": "object" }, +"DiskIoScheduler": { +"description": "DiskIoScheduler contains the configuration for the disk IO scheduler.", +"id": "DiskIoScheduler", +"properties": { +"nodeAttachedDiskIoScheduler": { +"description": "Optional. Configures the IO scheduler for the attached disks. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`.", +"type": "string" +}, +"nodeSystemIoScheduler": { +"description": "Optional. Configures the IO scheduler for the boot disk or ephemeral lssd that runs node system workloads. Supported values are `mq-deadline`, `bfq`, `kyber`, `none`.", +"type": "string" +} +}, +"type": "object" +}, "DisruptionBudget": { "description": "DisruptionBudget defines the upgrade disruption budget for the cluster control plane.", "id": "DisruptionBudget", @@ -6553,6 +6572,25 @@ false }, "type": "object" }, +"KubeletCertInfo": { +"description": "Contains expiry information about the kubelet certificate.", +"id": "KubeletCertInfo", +"properties": { +"nonTpmBootstrapCertExpireTime": { +"description": "Output only.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"tpmBootstrapCertExpireTime": { +"description": "Output only.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "KubernetesDashboard": { "description": "Configuration for the Kubernetes Dashboard.", "id": "KubernetesDashboard", @@ -6601,6 +6639,10 @@ false "$ref": "CustomNodeInit", "description": "Optional. Allow users to run arbitrary bash script or container on the node." }, +"diskIoScheduler": { +"$ref": "DiskIoScheduler", +"description": "Optional. Controls the configuration for the disk IO scheduler." +}, "hugepages": { "$ref": "HugepagesConfig", "description": "Optional. Amounts for 2M and 1G hugepages" @@ -6609,6 +6651,10 @@ false "$ref": "NodeKernelModuleLoading", "description": "Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification." }, +"nodeVfioConfig": { +"$ref": "NodeVfioConfig", +"description": "Optional. Contains VFIO-related configurations for this node." +}, "swapConfig": { "$ref": "SwapConfig", "description": "Optional. Enables and configures swap space on nodes. If omitted, swap is disabled." @@ -6617,7 +6663,7 @@ false "additionalProperties": { "type": "string" }, -"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", +"description": "The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.neigh.default.gc_thresh1 net.ipv4.neigh.default.gc_thresh2 net.ipv4.neigh.default.gc_thresh3 net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.keys.maxkeys kernel.keys.maxbytes kernel.shmmni kernel.shmmax kernel.shmall kernel.core_pattern kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes", "type": "object" }, "transparentHugepageDefrag": { @@ -8082,6 +8128,11 @@ false "readOnly": true, "type": "array" }, +"kubeletCertInfo": { +"$ref": "KubeletCertInfo", +"description": "Output only. Contains expiry information about the kubelet certificate.", +"readOnly": true +}, "locations": { "description": "The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.", "items": { @@ -8426,6 +8477,18 @@ false }, "type": "object" }, +"NodeVfioConfig": { +"description": "Configuration settings for VFIO (Virtual Function I/O) on a node. VFIO allows safe, unprivileged, userspace drivers to access I/O devices.", +"id": "NodeVfioConfig", +"properties": { +"dmaEntryLimit": { +"description": "Optional. Specifies the maximum number of DMA entries (pages) that can be mapped by the VFIO IOMMU type 1 driver for a container. This limit affects the total amount of host memory that can be pinned for direct device access, which is often critical for high-performance devices like TPUs and GPUs. This setting corresponds to the kernel parameter at: `/sys/module/vfio_iommu_type1/parameters/dma_entry_limit`. The default value in the kernel is `65535`. Higher values may be needed for workloads mapping large memory regions. Supported values are integers between `65535` and `4194304`.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "NotificationConfig": { "description": "NotificationConfig is the configuration of notifications.", "id": "NotificationConfig", @@ -10419,7 +10482,7 @@ false "type": "object" }, "TopologyManager": { -"description": "TopologyManager defines the configuration options for Topology Manager feature. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/", +"description": "TopologyManager defines the configuration options for the [`kubelet` Topology Manager component](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/). For more information about the supported machine types and versions for the Topology Manager in GKE, see [Customizing node system configuration](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-resource-managers).", "id": "TopologyManager", "properties": { "policy": { From 0e317c1ff027afe6390b981ecf0d2350d2d3358c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:51 +0000 Subject: [PATCH 24/50] fix(dataform): update the api #### dataform:v1 The following keys were changed: - endpoints (Total Keys: 1) #### dataform:v1beta1 The following keys were changed: - endpoints (Total Keys: 1) --- .../documents/dataform.v1.json | 22 +------------------ .../documents/dataform.v1beta1.json | 22 +------------------ 2 files changed, 2 insertions(+), 42 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index f0403316ec..63b71d17fa 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -90,11 +90,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.europe-north2.rep.googleapis.com/", -"location": "europe-north2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -115,11 +110,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.europe-west15.rep.googleapis.com/", -"location": "europe-west15" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-west2.rep.googleapis.com/", "location": "europe-west2" }, @@ -175,11 +165,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.northamerica-south1.rep.googleapis.com/", -"location": "northamerica-south1" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1" }, @@ -210,11 +195,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.us-east7.rep.googleapis.com/", -"location": "us-east7" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.us-south1.rep.googleapis.com/", "location": "us-south1" }, @@ -3240,7 +3220,7 @@ } } }, -"revision": "20260621", +"revision": "20260702", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index f16b18957d..0630045ddc 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -90,11 +90,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.europe-north2.rep.googleapis.com/", -"location": "europe-north2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-southwest1.rep.googleapis.com/", "location": "europe-southwest1" }, @@ -115,11 +110,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.europe-west15.rep.googleapis.com/", -"location": "europe-west15" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.europe-west2.rep.googleapis.com/", "location": "europe-west2" }, @@ -175,11 +165,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.northamerica-south1.rep.googleapis.com/", -"location": "northamerica-south1" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1" }, @@ -210,11 +195,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dataform.us-east7.rep.googleapis.com/", -"location": "us-east7" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dataform.us-south1.rep.googleapis.com/", "location": "us-south1" }, @@ -3281,7 +3261,7 @@ } } }, -"revision": "20260621", +"revision": "20260702", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { From 9f07079da50a12306216cdd1f275d340d3404a21 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:52 +0000 Subject: [PATCH 25/50] feat(dataplex): update the api #### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataDomain.properties.policyMember (Total Keys: 2) - schemas.GoogleIamV1ResourcePolicyMember (Total Keys: 6) --- ...lex_v1.projects.locations.dataDomains.html | 16 +++++++++++++ .../documents/dataplex.v1.json | 24 ++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/dyn/dataplex_v1.projects.locations.dataDomains.html b/docs/dyn/dataplex_v1.projects.locations.dataDomains.html index 0d0ebd5904..cd89b3aa9a 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataDomains.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataDomains.html @@ -142,6 +142,10 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id} "parentDataDomain": "A String", # Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Output-only policy member strings of this resource. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resourceExample: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5 + }, "uid": "A String", # Output only. System-generated globally unique ID for the DataDomain. "updateTime": "A String", # Output only. The time at which the DataDomain was last updated. } @@ -244,6 +248,10 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id} "parentDataDomain": "A String", # Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Output-only policy member strings of this resource. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resourceExample: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5 + }, "uid": "A String", # Output only. System-generated globally unique ID for the DataDomain. "updateTime": "A String", # Output only. The time at which the DataDomain was last updated. }
@@ -335,6 +343,10 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id} "parentDataDomain": "A String", # Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Output-only policy member strings of this resource. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resourceExample: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5 + }, "uid": "A String", # Output only. System-generated globally unique ID for the DataDomain. "updateTime": "A String", # Output only. The time at which the DataDomain was last updated. }, @@ -384,6 +396,10 @@

Method Details

}, "name": "A String", # Identifier. The relative resource name of the DataDomain, of the form: projects/{project_id_or_number}/locations/{location_id}/dataDomains/{data_domain_id} "parentDataDomain": "A String", # Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Output-only policy member strings of this resource. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resourceExample: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5 + }, "uid": "A String", # Output only. System-generated globally unique ID for the DataDomain. "updateTime": "A String", # Output only. The time at which the DataDomain was last updated. } diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 60633e8be4..226445fe1f 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -8038,7 +8038,7 @@ } } }, -"revision": "20260619", +"revision": "20260623", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -10022,6 +10022,11 @@ "description": "Optional. Immutable. The resource name of the parent DataDomain. Empty if this is a top-level DataDomain. Format: projects/{project_id_or_number}/locations/{location}/dataDomains/{parent_data_domain_id} This field is immutable after creation.", "type": "string" }, +"policyMember": { +"$ref": "GoogleIamV1ResourcePolicyMember", +"description": "Output only. Output-only policy member strings of this resource.", +"readOnly": true +}, "uid": { "description": "Output only. System-generated globally unique ID for the DataDomain.", "readOnly": true, @@ -16734,6 +16739,23 @@ }, "type": "object" }, +"GoogleIamV1ResourcePolicyMember": { +"description": "Output-only policy member strings of a Google Cloud resource's built-in identity.", +"id": "GoogleIamV1ResourcePolicyMember", +"properties": { +"iamPolicyNamePrincipal": { +"description": "Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource.Example: principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter", +"readOnly": true, +"type": "string" +}, +"iamPolicyUidPrincipal": { +"description": "Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resourceExample: principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleIamV1SetIamPolicyRequest": { "description": "Request message for SetIamPolicy method.", "id": "GoogleIamV1SetIamPolicyRequest", From 953f0aad61dd1cf88175217b82e200b961e50d18 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:52 +0000 Subject: [PATCH 26/50] feat(datastore): update the api #### datastore:v1 The following keys were added: - schemas.AllocateIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BeginTransactionRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.CommitRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.LookupRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RequestOptions (Total Keys: 4) - schemas.ReserveIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RollbackRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.requestOptions.$ref (Total Keys: 1) --- docs/dyn/datastore_v1.projects.html | 40 ++++++++++++++++ .../documents/datastore.v1.json | 48 ++++++++++++++++++- 2 files changed, 87 insertions(+), 1 deletion(-) diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index b94ec23c46..4bf920deab 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -145,6 +145,11 @@

Method Details

], }, ], + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -186,6 +191,11 @@

Method Details

{ # The request for Datastore.BeginTransaction. "databaseId": "A String", # The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, "transactionOptions": { # Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. # Options for a new transaction. "readOnly": { # Options specific to read-only transactions. # The transaction should only allow reads. "readTime": "A String", # Reads entities at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. @@ -532,6 +542,11 @@

Method Details

}, }, ], + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, "singleUseTransaction": { # Options for beginning a new transaction. Transactions can be created explicitly with calls to Datastore.BeginTransaction or implicitly by setting ReadOptions.new_transaction in read requests. # Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite. "readOnly": { # Options specific to read-only transactions. # The transaction should only allow reads. "readTime": "A String", # Reads entities at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. @@ -767,6 +782,11 @@

Method Details

"readTime": "A String", # Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. "transaction": "A String", # The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. }, + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -948,6 +968,11 @@

Method Details

], }, ], + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -973,6 +998,11 @@

Method Details

{ # The request for Datastore.Rollback. "databaseId": "A String", # The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database. + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, "transaction": "A String", # Required. The transaction identifier, returned by a call to Datastore.BeginTransaction. } @@ -1248,6 +1278,11 @@

Method Details

"readTime": "A String", # Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. "transaction": "A String", # The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. }, + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -1714,6 +1749,11 @@

Method Details

"readTime": "A String", # Reads entities as they were at the given time. This value is only supported for Cloud Firestore in Datastore mode. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. "transaction": "A String", # The identifier of the transaction in which to read. A transaction identifier is returned by a call to Datastore.BeginTransaction. }, + "requestOptions": { # Options for a request. # Optional. The options for this request. + "requestTags": [ # Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags. + "A String", + ], + }, } x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index af0e76dfb0..72aea43af4 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -1111,7 +1111,7 @@ } } }, -"revision": "20260323", +"revision": "20260702", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { @@ -1220,6 +1220,10 @@ "$ref": "Key" }, "type": "array" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." } }, "type": "object" @@ -1271,6 +1275,10 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." +}, "transactionOptions": { "$ref": "TransactionOptions", "description": "Options for a new transaction." @@ -1319,6 +1327,10 @@ }, "type": "array" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." +}, "singleUseTransaction": { "$ref": "TransactionOptions", "description": "Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite." @@ -2395,6 +2407,10 @@ "readOptions": { "$ref": "ReadOptions", "description": "The options for this lookup request." +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." } }, "type": "object" @@ -2931,6 +2947,20 @@ }, "type": "object" }, +"RequestOptions": { +"description": "Options for a request.", +"id": "RequestOptions", +"properties": { +"requestTags": { +"description": "Optional. The request tags for the request. The tags are processed as follows: - Truncated to 510 characters. - Filtered out if empty. - Deduplicated. - Limited to 50 tags.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ReserveIdsRequest": { "description": "The request for Datastore.ReserveIds.", "id": "ReserveIdsRequest", @@ -2945,6 +2975,10 @@ "$ref": "Key" }, "type": "array" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." } }, "type": "object" @@ -2963,6 +2997,10 @@ "description": "The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." +}, "transaction": { "description": "Required. The transaction identifier, returned by a call to Datastore.BeginTransaction.", "format": "byte", @@ -3004,6 +3042,10 @@ "readOptions": { "$ref": "ReadOptions", "description": "The options for this query." +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." } }, "type": "object" @@ -3063,6 +3105,10 @@ "readOptions": { "$ref": "ReadOptions", "description": "The options for this query." +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The options for this request." } }, "type": "object" From 1dc887540b29a0183230ec207b1b36e900f933d3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:53 +0000 Subject: [PATCH 27/50] fix(datastream): update the api #### datastream:v1 The following keys were changed: - endpoints (Total Keys: 1) #### datastream:v1alpha1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/datastream.v1.json | 12 +----------- .../documents/datastream.v1alpha1.json | 12 +----------- 2 files changed, 2 insertions(+), 22 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 1b59113783..c500b853ad 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -198,11 +198,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://datastream.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://datastream.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -245,11 +240,6 @@ "description": "Regional Endpoint", "endpointUrl": "https://datastream.us-west4.rep.googleapis.com/", "location": "us-west4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://datastream.us-west8.rep.googleapis.com/", -"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1503,7 +1493,7 @@ } } }, -"revision": "20260617", +"revision": "20260623", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json index 4ee96a4749..3f8f499b8c 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json @@ -198,11 +198,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://datastream.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://datastream.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -245,11 +240,6 @@ "description": "Regional Endpoint", "endpointUrl": "https://datastream.us-west4.rep.googleapis.com/", "location": "us-west4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://datastream.us-west8.rep.googleapis.com/", -"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1472,7 +1462,7 @@ } } }, -"revision": "20260426", +"revision": "20260623", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { From 58bcc70e236a1c985530f03a3d8602b65ad4710b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:53 +0000 Subject: [PATCH 28/50] feat(developerknowledge): update the api #### developerknowledge:v1 The following keys were added: - schemas.Document.properties.contentLengthBytes (Total Keys: 3) #### developerknowledge:v1alpha The following keys were added: - schemas.Document.properties.contentLengthBytes (Total Keys: 3) --- docs/dyn/developerknowledge_v1.documents.html | 11 +++++++---- .../developerknowledge_v1alpha.documents.html | 11 +++++++---- .../developerknowledge_v1alpha.v1alpha.html | 1 + .../documents/developerknowledge.v1.json | 18 ++++++++++++------ .../documents/developerknowledge.v1alpha.json | 18 ++++++++++++------ 5 files changed, 39 insertions(+), 20 deletions(-) diff --git a/docs/dyn/developerknowledge_v1.documents.html b/docs/dyn/developerknowledge_v1.documents.html index 0b6a9d2ffd..3689f8318b 100644 --- a/docs/dyn/developerknowledge_v1.documents.html +++ b/docs/dyn/developerknowledge_v1.documents.html @@ -99,7 +99,7 @@

Method Details

view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`. Allowed values DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. - DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. DOCUMENT_VIEW_FULL - Includes all Document fields. DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. @@ -114,6 +114,7 @@

Method Details

"documents": [ # Contains the documents requested. { # A Document represents a piece of content from the Developer Knowledge corpus. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` @@ -140,7 +141,7 @@

Method Details

view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`. Allowed values DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. - DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. DOCUMENT_VIEW_FULL - Includes all Document fields. DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. @@ -153,6 +154,7 @@

Method Details

{ # A Document represents a piece of content from the Developer Knowledge corpus. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` @@ -168,8 +170,8 @@

Method Details

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
 
 Args:
-  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
-  pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.
+  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
+  pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
   query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
   x__xgafv: string, V1 error format.
@@ -187,6 +189,7 @@ 

Method Details

"content": "A String", # Output only. Contains the content of the document chunk. "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` diff --git a/docs/dyn/developerknowledge_v1alpha.documents.html b/docs/dyn/developerknowledge_v1alpha.documents.html index 478f48da6d..445505f9c5 100644 --- a/docs/dyn/developerknowledge_v1alpha.documents.html +++ b/docs/dyn/developerknowledge_v1alpha.documents.html @@ -99,7 +99,7 @@

Method Details

view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`. Allowed values DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. - DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. DOCUMENT_VIEW_FULL - Includes all Document fields. DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. @@ -114,6 +114,7 @@

Method Details

"documents": [ # Contains the documents requested. { # A Document represents a piece of content from the Developer Knowledge corpus. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` @@ -140,7 +141,7 @@

Method Details

view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`. Allowed values DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified. - DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. + DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks. DOCUMENT_VIEW_FULL - Includes all Document fields. DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments. x__xgafv: string, V1 error format. @@ -153,6 +154,7 @@

Method Details

{ # A Document represents a piece of content from the Developer Knowledge corpus. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` @@ -168,8 +170,8 @@

Method Details

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.
 
 Args:
-  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
-  pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.
+  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
+  pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.
   pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
   query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
   x__xgafv: string, V1 error format.
@@ -187,6 +189,7 @@ 

Method Details

"content": "A String", # Output only. Contains the content of the document chunk. "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` diff --git a/docs/dyn/developerknowledge_v1alpha.v1alpha.html b/docs/dyn/developerknowledge_v1alpha.v1alpha.html index 285b8c8e8b..25a6124c9a 100644 --- a/docs/dyn/developerknowledge_v1alpha.v1alpha.html +++ b/docs/dyn/developerknowledge_v1alpha.v1alpha.html @@ -122,6 +122,7 @@

Method Details

"content": "A String", # Output only. Contains the content of the document chunk. "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content. "content": "A String", # Output only. Contains the full content of the document in Markdown format. + "contentLengthBytes": 42, # Output only. The length of the `content` field in bytes. "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com` "description": "A String", # Output only. Provides a description of the document. "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json index a0644f9013..d02b004311 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1.json @@ -130,7 +130,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], @@ -172,7 +172,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], @@ -196,12 +196,12 @@ "parameterOrder": [], "parameters": { "filter": { -"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.", +"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.", +"description": "Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" @@ -228,7 +228,7 @@ } } }, -"revision": "20260524", +"revision": "20260705", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "BatchGetDocumentsResponse": { @@ -254,6 +254,12 @@ "readOnly": true, "type": "string" }, +"contentLengthBytes": { +"description": "Output only. The length of the `content` field in bytes.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "dataSource": { "description": "Output only. Specifies the data source of the document. Example data source: `firebase.google.com`", "readOnly": true, @@ -294,7 +300,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], diff --git a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json index 1915679ef0..ad4e78dac5 100644 --- a/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/developerknowledge.v1alpha.json @@ -130,7 +130,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], @@ -172,7 +172,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], @@ -196,12 +196,12 @@ "parameterOrder": [], "parameters": { "filter": { -"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.", +"description": "Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `content_length_bytes` (INTEGER): The length of the `Document.content` field in bytes. * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. INTEGER fields support `=`, `<`, `<=`, `>`, and `>=` operators. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `\"2025-01-01T00:00:00Z\"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * Filter by `Document.content_length_bytes`: `content_length_bytes < 50000` * `data_source = \"docs.cloud.google.com\" OR data_source = \"firebase.google.com\"` * `data_source != \"firebase.google.com\"` * `update_time < \"2024-01-01T00:00:00Z\"` * `update_time >= \"2025-01-22T00:00:00Z\" AND (data_source = \"developer.chrome.com\" OR data_source = \"web.dev\")` * `uri = \"https://docs.cloud.google.com/release-notes\"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.", +"description": "Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" @@ -250,7 +250,7 @@ } } }, -"revision": "20260524", +"revision": "20260705", "rootUrl": "https://developerknowledge.googleapis.com/", "schemas": { "Answer": { @@ -377,6 +377,12 @@ "readOnly": true, "type": "string" }, +"contentLengthBytes": { +"description": "Output only. The length of the `content` field in bytes.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "dataSource": { "description": "Output only. Specifies the data source of the document. Example data source: `firebase.google.com`", "readOnly": true, @@ -417,7 +423,7 @@ ], "enumDescriptions": [ "The default / unset value. See each API method for its default value if DocumentView is not specified.", -"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", +"Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` - `content_length_bytes` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.", "Includes all Document fields.", "Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments." ], From 284b014bd54a176ff127fc92951239876b0d1db4 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:53 +0000 Subject: [PATCH 29/50] feat(dialogflow): update the api #### dialogflow:v2 The following keys were added: - schemas.GoogleCloudDialogflowV2InputAudioConfig.properties.enableVoiceActivityEvents.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2SearchKnowledgeDebugInfo.properties.cesDebugInfo (Total Keys: 2) #### dialogflow:v2beta1 The following keys were added: - schemas.GoogleCloudDialogflowV2beta1InputAudioConfig.properties.enableVoiceActivityEvents.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1SearchKnowledgeDebugInfo.properties.cesDebugInfo (Total Keys: 2) --- ...cts.agent.environments.users.sessions.html | 1 + ...dialogflow_v2.projects.agent.sessions.html | 1 + ...2.projects.conversations.participants.html | 1 + ...v2.projects.conversations.suggestions.html | 3 ++ ...ons.agent.environments.users.sessions.html | 1 + ..._v2.projects.locations.agent.sessions.html | 1 + ....locations.conversations.participants.html | 1 + ...s.locations.conversations.suggestions.html | 3 ++ ...low_v2.projects.locations.suggestions.html | 3 ++ .../dialogflow_v2.projects.suggestions.html | 3 ++ ...cts.agent.environments.users.sessions.html | 1 + ...gflow_v2beta1.projects.agent.sessions.html | 1 + ...1.projects.conversations.participants.html | 1 + ...a1.projects.conversations.suggestions.html | 3 ++ ...ons.agent.environments.users.sessions.html | 1 + ...ta1.projects.locations.agent.sessions.html | 1 + ....locations.conversations.participants.html | 1 + ...s.locations.conversations.suggestions.html | 3 ++ ...2beta1.projects.locations.suggestions.html | 3 ++ ...alogflow_v2beta1.projects.suggestions.html | 3 ++ .../documents/dialogflow.v2.json | 28 +++++++++++++++++-- .../documents/dialogflow.v2beta1.json | 28 +++++++++++++++++-- .../documents/dialogflow.v3.json | 18 ++++++++++-- .../documents/dialogflow.v3beta1.json | 18 ++++++++++-- 24 files changed, 116 insertions(+), 12 deletions(-) diff --git a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html index 9393d671c6..af19f913f4 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.environments.users.sessions.html @@ -157,6 +157,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.agent.sessions.html index 05742d69ce..4ac7ae0980 100644 --- a/docs/dyn/dialogflow_v2.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.agent.sessions.html @@ -157,6 +157,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index 75b7ec1fcf..2e4be2b1d6 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -122,6 +122,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html index c72a7bd2cc..a857cdc870 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.suggestions.html @@ -334,6 +334,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html index 35f8701027..3c3e7be359 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.environments.users.sessions.html @@ -157,6 +157,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html index 8d27eabf45..de671857f5 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.agent.sessions.html @@ -157,6 +157,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index 0e2702ceb3..4af7dac490 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -122,6 +122,7 @@

Method Details

"audioEncoding": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html index b252977548..b8e33ea37a 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.suggestions.html @@ -334,6 +334,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index 31907ac42d..d0c3d78db4 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -487,6 +487,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 7ae7880c94..85e9698337 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -487,6 +487,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html index 1e40d594bf..a248635e12 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.environments.users.sessions.html @@ -162,6 +162,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html index 719ae3aa8f..201929bec8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.agent.sessions.html @@ -162,6 +162,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 1446322abb..f57630e87c 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -127,6 +127,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html index 4b0fd404fd..b713c67572 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.suggestions.html @@ -334,6 +334,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html index ae354adb2e..4216a101ad 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.environments.users.sessions.html @@ -162,6 +162,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html index a6732d134f..0fd9d81240 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.agent.sessions.html @@ -162,6 +162,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 6e9ef93801..3605991d74 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -127,6 +127,7 @@

Method Details

"defaultNoSpeechTimeout": "A String", "disableNoSpeechRecognizedEvent": True or False, "enableAutomaticPunctuation": True or False, + "enableVoiceActivityEvents": True or False, "enableWordInfo": True or False, "languageCode": "A String", "model": "A String", diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html index d59c88057a..c60b11e035 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.suggestions.html @@ -334,6 +334,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index c863710c10..4ca7a75117 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -512,6 +512,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 0d8685480a..54d8d1ec60 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -512,6 +512,9 @@

Method Details

], "rewrittenQuery": "A String", "searchKnowledgeDebugInfo": { + "cesDebugInfo": { + "a_key": "", # Properties of the object. + }, "datastoreResponseReason": "A String", "ingestedContextReferenceDebugInfo": { "contextReferenceRetrieved": True or False, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 6bc27a10ba..0372cd4b8a 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8780,7 +8780,7 @@ } } }, -"revision": "20260616", +"revision": "20260701", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16211,6 +16211,9 @@ true "enableAutomaticPunctuation": { "type": "boolean" }, +"enableVoiceActivityEvents": { +"type": "boolean" +}, "enableWordInfo": { "type": "boolean" }, @@ -18279,6 +18282,13 @@ false "GoogleCloudDialogflowV2SearchKnowledgeDebugInfo": { "id": "GoogleCloudDialogflowV2SearchKnowledgeDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -18945,11 +18955,19 @@ false "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", -"END_OF_SINGLE_UTTERANCE" +"DTMF_DIGITS", +"END_OF_SINGLE_UTTERANCE", +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", +"", +"", +"", +"", "" ], "type": "string" @@ -22999,13 +23017,17 @@ true "TRANSCRIPT", "END_OF_SINGLE_UTTERANCE", "DTMF_DIGITS", -"PARTIAL_DTMF_DIGITS" +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index ceae040c6c..b6af10b9cc 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8431,7 +8431,7 @@ } } }, -"revision": "20260622", +"revision": "20260701", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14884,11 +14884,19 @@ true "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", -"END_OF_SINGLE_UTTERANCE" +"DTMF_DIGITS", +"END_OF_SINGLE_UTTERANCE", +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", +"", +"", +"", +"", "" ], "type": "string" @@ -18338,6 +18346,9 @@ true "enableAutomaticPunctuation": { "type": "boolean" }, +"enableVoiceActivityEvents": { +"type": "boolean" +}, "enableWordInfo": { "type": "boolean" }, @@ -20851,6 +20862,13 @@ false "GoogleCloudDialogflowV2beta1SearchKnowledgeDebugInfo": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeDebugInfo", "properties": { +"cesDebugInfo": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, "datastoreResponseReason": { "enum": [ "DATASTORE_RESPONSE_REASON_UNSPECIFIED", @@ -21471,13 +21489,17 @@ false "TRANSCRIPT", "END_OF_SINGLE_UTTERANCE", "DTMF_DIGITS", -"PARTIAL_DTMF_DIGITS" +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index aa73b9c31d..5aab6ce369 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -5031,7 +5031,7 @@ } } }, -"revision": "20260616", +"revision": "20260701", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -15702,11 +15702,19 @@ true "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", -"END_OF_SINGLE_UTTERANCE" +"DTMF_DIGITS", +"END_OF_SINGLE_UTTERANCE", +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", +"", +"", +"", +"", "" ], "type": "string" @@ -18603,13 +18611,17 @@ true "TRANSCRIPT", "END_OF_SINGLE_UTTERANCE", "DTMF_DIGITS", -"PARTIAL_DTMF_DIGITS" +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 5429fc8542..4be1367237 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5151,7 +5151,7 @@ } } }, -"revision": "20260616", +"revision": "20260701", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -16747,11 +16747,19 @@ true "enum": [ "MESSAGE_TYPE_UNSPECIFIED", "TRANSCRIPT", -"END_OF_SINGLE_UTTERANCE" +"DTMF_DIGITS", +"END_OF_SINGLE_UTTERANCE", +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", +"", +"", +"", +"", "" ], "type": "string" @@ -19648,13 +19656,17 @@ true "TRANSCRIPT", "END_OF_SINGLE_UTTERANCE", "DTMF_DIGITS", -"PARTIAL_DTMF_DIGITS" +"PARTIAL_DTMF_DIGITS", +"SPEECH_ACTIVITY_BEGIN", +"SPEECH_ACTIVITY_END" ], "enumDescriptions": [ "", "", "", "", +"", +"", "" ], "type": "string" From 6ff1c4e667f32e19c534cc9a288e93c44f38b8d5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:55 +0000 Subject: [PATCH 30/50] feat(discoveryengine): update the api #### discoveryengine:v1 The following keys were added: - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettings.properties.googleDrivePickerEnabled (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettings.properties.onedrivePickerEnabled (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel.properties.adminView (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView (Total Keys: 9) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores (Total Keys: 9) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment (Total Keys: 62) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram (Total Keys: 22) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata.properties.updateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.acquirePrograms (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.resume (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.start (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.methods.submitProgramsEvaluations (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.resources.alphaEvolvePrograms.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.resources.alphaEvolvePrograms.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.collections.resources.engines.resources.sessions.resources.alphaEvolveExperiments.resources.alphaEvolvePrograms.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.userStores.resources.userLicenses.methods.export (Total Keys: 12) - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores (Total Keys: 9) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment (Total Keys: 62) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram (Total Keys: 27) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata.properties.updateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse (Total Keys: 7) - schemas.GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest (Total Keys: 4) - schemas.GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.googleDrivePickerEnabled (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettings.properties.onedrivePickerEnabled (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel.properties.adminView (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView (Total Keys: 9) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) #### discoveryengine:v1beta The following keys were added: - schemas.GoogleCloudDiscoveryengineV1DataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1Engine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores (Total Keys: 9) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment (Total Keys: 62) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram (Total Keys: 22) - schemas.GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile (Total Keys: 5) - schemas.GoogleCloudDiscoveryengineV1alphaDataConnector.properties.oauthStaticIpAddresses (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1alphaDeleteUserStoreMetadata.properties.updateTime (Total Keys: 2) - schemas.GoogleCloudDiscoveryengineV1alphaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) - schemas.GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata (Total Keys: 8) - schemas.GoogleCloudDiscoveryengineV1alphaStartExperimentRequest (Total Keys: 3) - schemas.GoogleCloudDiscoveryengineV1betaEngine.properties.associatedAgentRegistry.readOnly (Total Keys: 1) --- ....collections.dataStores.widgetConfigs.html | 33 +- ...rojects.locations.collections.engines.html | 30 +- ...ons.collections.engines.widgetConfigs.html | 33 +- ...ine_v1.projects.locations.collections.html | 9 + ...ts.locations.dataStores.widgetConfigs.html | 33 +- ...discoveryengine_v1.projects.locations.html | 6 + ...ects.locations.collections.dataStores.html | 6 +- ....collections.dataStores.widgetConfigs.html | 33 +- ...rojects.locations.collections.engines.html | 48 +- ...EvolveExperiments.alphaEvolvePrograms.html | 331 +++ ...gines.sessions.alphaEvolveExperiments.html | 475 ++++ ...ons.collections.engines.widgetConfigs.html | 33 +- ...1alpha.projects.locations.collections.html | 18 + ...v1alpha.projects.locations.dataStores.html | 6 +- ...ts.locations.dataStores.widgetConfigs.html | 33 +- ...veryengine_v1alpha.projects.locations.html | 6 + ...cts.locations.userStores.userLicenses.html | 28 + ...rojects.locations.collections.engines.html | 42 +- .../documents/discoveryengine.v1.json | 532 +++- .../documents/discoveryengine.v1alpha.json | 2503 ++++++++++++----- .../documents/discoveryengine.v1beta.json | 490 +++- 21 files changed, 3873 insertions(+), 855 deletions(-) create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.html diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html index 525d1a447d..36fe60b7e7 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.widgetConfigs.html @@ -307,7 +307,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -322,11 +322,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -338,6 +346,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -554,7 +563,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -569,11 +578,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -585,6 +602,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -800,7 +818,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -815,11 +833,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -831,6 +857,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html index 5759321128..7429d6c45c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html @@ -163,7 +163,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -204,7 +204,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -254,7 +254,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -350,7 +350,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -391,7 +391,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -441,7 +441,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -513,7 +513,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -554,7 +554,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -604,7 +604,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -648,7 +648,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -689,7 +689,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -739,7 +739,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -765,7 +765,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -806,7 +806,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -856,7 +856,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html index 10f6ebbdd0..bad7175e05 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.widgetConfigs.html @@ -307,7 +307,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -322,11 +322,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -338,6 +346,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -554,7 +563,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -569,11 +578,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -585,6 +602,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -800,7 +818,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -815,11 +833,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -831,6 +857,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html index 9c53095689..ec5223a247 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html @@ -352,6 +352,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -588,6 +591,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -823,6 +829,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html index 85fbefcb30..bc4ffbe1d0 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.widgetConfigs.html @@ -307,7 +307,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -322,11 +322,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -338,6 +346,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -554,7 +563,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -569,11 +578,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -585,6 +602,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. @@ -800,7 +818,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -815,11 +833,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -831,6 +857,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. }, "updateTime": "A String", # Output only. Timestamp the WidgetConfig was updated. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index dba9bf70ad..deb7cd726d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -414,6 +414,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -679,6 +682,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html index 1ea25d9550..ec343cbf39 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.html @@ -842,7 +842,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
@@ -1765,7 +1765,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. } @@ -1787,7 +1787,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html index 13dba19d2e..3c73f5e074 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.widgetConfigs.html @@ -312,7 +312,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -327,11 +327,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -343,6 +351,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -569,7 +578,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -584,11 +593,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -600,6 +617,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -825,7 +843,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -840,11 +858,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -856,6 +882,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html index a9d274f6d2..f9a66bc38f 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html @@ -186,7 +186,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -227,7 +227,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -284,7 +284,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -382,7 +382,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -423,7 +423,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -480,7 +480,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -515,7 +515,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
@@ -602,7 +602,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -643,7 +643,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -700,7 +700,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -746,7 +746,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -787,7 +787,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -844,7 +844,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -872,7 +872,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -913,7 +913,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -970,7 +970,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -1010,7 +1010,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -1051,7 +1051,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1108,7 +1108,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -1148,7 +1148,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -1189,7 +1189,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1246,7 +1246,7 @@

Method Details

"tuningOperation": "A String", # Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty. }, "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -1375,7 +1375,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. } @@ -1397,7 +1397,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.html new file mode 100644 index 0000000000..05da733add --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.html @@ -0,0 +1,331 @@ + + + +

Discovery Engine API . projects . locations . collections . engines . sessions . alphaEvolveExperiments . alphaEvolvePrograms

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a new AlphaEvolveProgram.

+

+ get(name, x__xgafv=None)

+

Gets an existing AlphaEvolveProgram.

+

+ list(parent, orderBy=None, pageSize=None, pageToken=None, stateFilter=None, x__xgafv=None)

+

List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new AlphaEvolveProgram.
+
+Args:
+  parent: string, Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a single program to be used within the context of an AlphaEvolve experiment.
+  "content": { # A self-contained message containing the content of a program. Can represent a collection of files. # Optional. Content of the program.
+    "description": "A String", # Optional. Description of the program.
+    "files": [ # Required. A list of source files that make up the overall program.
+      { # A single source file with its path, content and metadata.
+        "content": "A String", # Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
+        "description": "A String", # Optional. Additional description of the file.
+        "path": "A String", # Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
+        "programLanguage": "A String", # Optional. The programming language of the file.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Time when the program was created.
+  "evaluation": { # Evaluation results for a program candidate. # Optional. Evaluation results for the program.
+    "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+      "insights": [ # Optional. List of evaluation insights.
+        { # A single evaluation insight.
+          "label": "A String", # Optional. Label of the insight.
+          "text": "A String", # Optional. Text of the insight.
+        },
+      ],
+    },
+    "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+      "scores": [ # Required. List of evaluation scores.
+        { # Score for a single metric.
+          "metric": "A String", # Required. Name of the metric.
+          "score": 3.14, # Required. Score of a program for this metric.
+        },
+      ],
+    },
+  },
+  "lockToken": "A String", # Optional. Lock token for the program.
+  "name": "A String", # Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+  "parentPrograms": [ # Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the program.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single program to be used within the context of an AlphaEvolve experiment.
+  "content": { # A self-contained message containing the content of a program. Can represent a collection of files. # Optional. Content of the program.
+    "description": "A String", # Optional. Description of the program.
+    "files": [ # Required. A list of source files that make up the overall program.
+      { # A single source file with its path, content and metadata.
+        "content": "A String", # Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
+        "description": "A String", # Optional. Additional description of the file.
+        "path": "A String", # Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
+        "programLanguage": "A String", # Optional. The programming language of the file.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Time when the program was created.
+  "evaluation": { # Evaluation results for a program candidate. # Optional. Evaluation results for the program.
+    "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+      "insights": [ # Optional. List of evaluation insights.
+        { # A single evaluation insight.
+          "label": "A String", # Optional. Label of the insight.
+          "text": "A String", # Optional. Text of the insight.
+        },
+      ],
+    },
+    "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+      "scores": [ # Required. List of evaluation scores.
+        { # Score for a single metric.
+          "metric": "A String", # Required. Name of the metric.
+          "score": 3.14, # Required. Score of a program for this metric.
+        },
+      ],
+    },
+  },
+  "lockToken": "A String", # Optional. Lock token for the program.
+  "name": "A String", # Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+  "parentPrograms": [ # Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the program.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets an existing AlphaEvolveProgram.
+
+Args:
+  name: string, Required. The full resource name of the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a single program to be used within the context of an AlphaEvolve experiment.
+  "content": { # A self-contained message containing the content of a program. Can represent a collection of files. # Optional. Content of the program.
+    "description": "A String", # Optional. Description of the program.
+    "files": [ # Required. A list of source files that make up the overall program.
+      { # A single source file with its path, content and metadata.
+        "content": "A String", # Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
+        "description": "A String", # Optional. Additional description of the file.
+        "path": "A String", # Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
+        "programLanguage": "A String", # Optional. The programming language of the file.
+      },
+    ],
+  },
+  "createTime": "A String", # Output only. Time when the program was created.
+  "evaluation": { # Evaluation results for a program candidate. # Optional. Evaluation results for the program.
+    "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+      "insights": [ # Optional. List of evaluation insights.
+        { # A single evaluation insight.
+          "label": "A String", # Optional. Label of the insight.
+          "text": "A String", # Optional. Text of the insight.
+        },
+      ],
+    },
+    "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+      "scores": [ # Required. List of evaluation scores.
+        { # Score for a single metric.
+          "metric": "A String", # Required. Name of the metric.
+          "score": 3.14, # Required. Score of a program for this metric.
+        },
+      ],
+    },
+  },
+  "lockToken": "A String", # Optional. Lock token for the program.
+  "name": "A String", # Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+  "parentPrograms": [ # Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+    "A String",
+  ],
+  "state": "A String", # Output only. State of the program.
+}
+
+ +
+ list(parent, orderBy=None, pageSize=None, pageToken=None, stateFilter=None, x__xgafv=None) +
List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.
+
+Args:
+  parent: string, Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  orderBy: string, Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. "score1 desc, score2". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.
+  pageSize: integer, Optional. The maximum number of programs to return. The service may return fewer than this value.
+  pageToken: string, Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.
+  stateFilter: string, Optional. Filter to apply to the programs. Examples: "state_filter = \'COMPLETED\'" "state_filter = \'INITIALIZED\' OR "state_filter = \'EVALUATING\'" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.
+    Allowed values
+      PROGRAM_STATE_UNSPECIFIED - Default value. This value is unused.
+      INITIALIZED - The program is initialized.
+      GENERATING - The program is in generation.
+      EVALUATING - The program is pending evaluation.
+      COMPLETED - The program is completed.
+  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 AlphaEvolveService.ListAlphaEvolvePrograms.
+  "alphaEvolvePrograms": [ # Output only. List of programs matching the criteria provided in the request.
+    { # Represents a single program to be used within the context of an AlphaEvolve experiment.
+      "content": { # A self-contained message containing the content of a program. Can represent a collection of files. # Optional. Content of the program.
+        "description": "A String", # Optional. Description of the program.
+        "files": [ # Required. A list of source files that make up the overall program.
+          { # A single source file with its path, content and metadata.
+            "content": "A String", # Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
+            "description": "A String", # Optional. Additional description of the file.
+            "path": "A String", # Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
+            "programLanguage": "A String", # Optional. The programming language of the file.
+          },
+        ],
+      },
+      "createTime": "A String", # Output only. Time when the program was created.
+      "evaluation": { # Evaluation results for a program candidate. # Optional. Evaluation results for the program.
+        "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+          "insights": [ # Optional. List of evaluation insights.
+            { # A single evaluation insight.
+              "label": "A String", # Optional. Label of the insight.
+              "text": "A String", # Optional. Text of the insight.
+            },
+          ],
+        },
+        "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+          "scores": [ # Required. List of evaluation scores.
+            { # Score for a single metric.
+              "metric": "A String", # Required. Name of the metric.
+              "score": 3.14, # Required. Score of a program for this metric.
+            },
+          ],
+        },
+      },
+      "lockToken": "A String", # Optional. Lock token for the program.
+      "name": "A String", # Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+      "parentPrograms": [ # Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+        "A String",
+      ],
+      "state": "A String", # Output only. State of the program.
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html index 34366d2765..73be348b2e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.alphaEvolveExperiments.html @@ -74,18 +74,493 @@

Discovery Engine API . projects . locations . collections . engines . sessions . alphaEvolveExperiments

Instance Methods

+

+ alphaEvolvePrograms() +

+

Returns the alphaEvolvePrograms Resource.

+

operations()

Returns the operations Resource.

+

+ acquirePrograms(parent, body=None, x__xgafv=None)

+

Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.

close()

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Creates a new AlphaEvolveExperiment.

+

+ delete(name, x__xgafv=None)

+

Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).

+

+ get(name, x__xgafv=None)

+

Get an existing Experiment.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

List all AlphaEvolveExperiments in a given session.

+

+ list_next()

+

Retrieves the next page of results.

+

+ resume(name, body=None, x__xgafv=None)

+

Resumes a workflow to process the AlphaEvolveExperiment.

+

+ start(name, body=None, x__xgafv=None)

+

Starts a workflow to process the AlphaEvolveExperiment.

+

+ submitProgramsEvaluations(parent, body=None, x__xgafv=None)

+

Adds an AlphaEvolveProgramEvaluation to the experiment.

Method Details

+
+ acquirePrograms(parent, body=None, x__xgafv=None) +
Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.
+
+Args:
+  parent: string, Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AlphaEvolveService.AcquirePrograms.
+  "desiredProgramsCount": 42, # Optional. Number of evolved programs to acquire. If not set, the default value is 1.
+}
+
+  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 AlphaEvolveService.AcquirePrograms.
+  "programs": [ # Output only. List of acquired program candidates to be evaluated. Note: The number of programs acquired might be lower than requested.
+    { # Represents a single program to be used within the context of an AlphaEvolve experiment.
+      "content": { # A self-contained message containing the content of a program. Can represent a collection of files. # Optional. Content of the program.
+        "description": "A String", # Optional. Description of the program.
+        "files": [ # Required. A list of source files that make up the overall program.
+          { # A single source file with its path, content and metadata.
+            "content": "A String", # Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.
+            "description": "A String", # Optional. Additional description of the file.
+            "path": "A String", # Required. The relative path of the file, including the filename. e.g., "src/main.py", "utils/helpers.js", "README.md"
+            "programLanguage": "A String", # Optional. The programming language of the file.
+          },
+        ],
+      },
+      "createTime": "A String", # Output only. Time when the program was created.
+      "evaluation": { # Evaluation results for a program candidate. # Optional. Evaluation results for the program.
+        "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+          "insights": [ # Optional. List of evaluation insights.
+            { # A single evaluation insight.
+              "label": "A String", # Optional. Label of the insight.
+              "text": "A String", # Optional. Text of the insight.
+            },
+          ],
+        },
+        "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+          "scores": [ # Required. List of evaluation scores.
+            { # Score for a single metric.
+              "metric": "A String", # Required. Name of the metric.
+              "score": 3.14, # Required. Score of a program for this metric.
+            },
+          ],
+        },
+      },
+      "lockToken": "A String", # Optional. Lock token for the program.
+      "name": "A String", # Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+      "parentPrograms": [ # Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+        "A String",
+      ],
+      "state": "A String", # Output only. State of the program.
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a new AlphaEvolveExperiment.
+
+Args:
+  parent: string, Required. The parent resource name (Session) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
+  "config": { # Configuration of an experiment. # Required. Experiment configuration.
+    "evolutionSettings": { # Evolution settings for the experiment. # Optional. Evolution settings for the experiment.
+      "parentSamplingConfig": { # Configuration for parent sampling. # Optional. Parent sampling configuration.
+        "paretoSamplingConfig": { # Configuration for Pareto sampling. # Optional. Pareto sampling configuration.
+          "paretoSamplingProbability": 3.14, # Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
+        },
+      },
+    },
+    "generationSettings": { # Generation settings for the experiment. # Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
+      "context": "A String", # Optional. Additional user-provided context to be used during generation.
+      "includeFullProgramInPrompt": True or False, # Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
+      "models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
+        { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
+          "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
+          "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
+        },
+      ],
+    },
+    "problemDescription": "A String", # Required. Description of the problem to be solved by the experiment.
+    "programLanguage": "A String", # Required. Primary programming language of the code being optimized.
+    "runSettings": { # Run settings for the experiment. # Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
+      "concurrency": 42, # Required. Maximum number of programs that can be generated in parallel. Must be positive.
+      "maxDuration": "A String", # Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
+      "maxPrograms": 42, # Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
+    },
+    "title": "A String", # Required. Title of the experiment.
+  },
+  "createTime": "A String", # Output only. Time when the experiment was created.
+  "initialAlphaEvolveProgram": "A String", # Output only. Specifies the name of the seed program used to start the experiment.
+  "name": "A String", # Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`
+  "state": "A String", # Output only. The state of the experiment.
+  "stats": { # Stats about the experiment. # Output only. Experiment stats.
+    "candidatesCount": 42, # Output only. Number of candidates generated.
+    "evaluatedCandidatesCount": 42, # Output only. Number of candidates evaluated.
+    "inputTokenCount": "A String", # Output only. Number of billed input tokens consumed by the experiment.
+    "outputTokenCount": "A String", # Output only. Number of billed output tokens consumed by the experiment.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
+  "config": { # Configuration of an experiment. # Required. Experiment configuration.
+    "evolutionSettings": { # Evolution settings for the experiment. # Optional. Evolution settings for the experiment.
+      "parentSamplingConfig": { # Configuration for parent sampling. # Optional. Parent sampling configuration.
+        "paretoSamplingConfig": { # Configuration for Pareto sampling. # Optional. Pareto sampling configuration.
+          "paretoSamplingProbability": 3.14, # Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
+        },
+      },
+    },
+    "generationSettings": { # Generation settings for the experiment. # Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
+      "context": "A String", # Optional. Additional user-provided context to be used during generation.
+      "includeFullProgramInPrompt": True or False, # Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
+      "models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
+        { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
+          "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
+          "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
+        },
+      ],
+    },
+    "problemDescription": "A String", # Required. Description of the problem to be solved by the experiment.
+    "programLanguage": "A String", # Required. Primary programming language of the code being optimized.
+    "runSettings": { # Run settings for the experiment. # Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
+      "concurrency": 42, # Required. Maximum number of programs that can be generated in parallel. Must be positive.
+      "maxDuration": "A String", # Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
+      "maxPrograms": 42, # Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
+    },
+    "title": "A String", # Required. Title of the experiment.
+  },
+  "createTime": "A String", # Output only. Time when the experiment was created.
+  "initialAlphaEvolveProgram": "A String", # Output only. Specifies the name of the seed program used to start the experiment.
+  "name": "A String", # Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`
+  "state": "A String", # Output only. The state of the experiment.
+  "stats": { # Stats about the experiment. # Output only. Experiment stats.
+    "candidatesCount": 42, # Output only. Number of candidates generated.
+    "evaluatedCandidatesCount": 42, # Output only. Number of candidates evaluated.
+    "inputTokenCount": "A String", # Output only. Number of billed input tokens consumed by the experiment.
+    "outputTokenCount": "A String", # Output only. Number of billed output tokens consumed by the experiment.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).
+
+Args:
+  name: string, Required. The full resource name of the experiment to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Get an existing Experiment.
+
+Args:
+  name: string, Required. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
+  "config": { # Configuration of an experiment. # Required. Experiment configuration.
+    "evolutionSettings": { # Evolution settings for the experiment. # Optional. Evolution settings for the experiment.
+      "parentSamplingConfig": { # Configuration for parent sampling. # Optional. Parent sampling configuration.
+        "paretoSamplingConfig": { # Configuration for Pareto sampling. # Optional. Pareto sampling configuration.
+          "paretoSamplingProbability": 3.14, # Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
+        },
+      },
+    },
+    "generationSettings": { # Generation settings for the experiment. # Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
+      "context": "A String", # Optional. Additional user-provided context to be used during generation.
+      "includeFullProgramInPrompt": True or False, # Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
+      "models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
+        { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
+          "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
+          "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
+        },
+      ],
+    },
+    "problemDescription": "A String", # Required. Description of the problem to be solved by the experiment.
+    "programLanguage": "A String", # Required. Primary programming language of the code being optimized.
+    "runSettings": { # Run settings for the experiment. # Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
+      "concurrency": 42, # Required. Maximum number of programs that can be generated in parallel. Must be positive.
+      "maxDuration": "A String", # Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
+      "maxPrograms": 42, # Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
+    },
+    "title": "A String", # Required. Title of the experiment.
+  },
+  "createTime": "A String", # Output only. Time when the experiment was created.
+  "initialAlphaEvolveProgram": "A String", # Output only. Specifies the name of the seed program used to start the experiment.
+  "name": "A String", # Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`
+  "state": "A String", # Output only. The state of the experiment.
+  "stats": { # Stats about the experiment. # Output only. Experiment stats.
+    "candidatesCount": 42, # Output only. Number of candidates generated.
+    "evaluatedCandidatesCount": 42, # Output only. Number of candidates evaluated.
+    "inputTokenCount": "A String", # Output only. Number of billed input tokens consumed by the experiment.
+    "outputTokenCount": "A String", # Output only. Number of billed output tokens consumed by the experiment.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List all AlphaEvolveExperiments in a given session.
+
+Args:
+  parent: string, Required. The parent resource name (Session) of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` (required)
+  pageSize: integer, Optional. The maximum number of experiments to return. The service may return fewer than this value.
+  pageToken: string, Optional. A page token, received from a previous `ListAlphaEvolveExperiments` 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 AlphaEvolveService.ListAlphaEvolveExperiments.
+  "alphaEvolveExperiments": [ # Output only. List of experiments.
+    { # An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.
+      "config": { # Configuration of an experiment. # Required. Experiment configuration.
+        "evolutionSettings": { # Evolution settings for the experiment. # Optional. Evolution settings for the experiment.
+          "parentSamplingConfig": { # Configuration for parent sampling. # Optional. Parent sampling configuration.
+            "paretoSamplingConfig": { # Configuration for Pareto sampling. # Optional. Pareto sampling configuration.
+              "paretoSamplingProbability": 3.14, # Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.
+            },
+          },
+        },
+        "generationSettings": { # Generation settings for the experiment. # Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts.
+          "context": "A String", # Optional. Additional user-provided context to be used during generation.
+          "includeFullProgramInPrompt": True or False, # Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.
+          "models": [ # Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.
+            { # Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.
+              "name": "A String", # Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.
+              "weight": 3.14, # Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.
+            },
+          ],
+        },
+        "problemDescription": "A String", # Required. Description of the problem to be solved by the experiment.
+        "programLanguage": "A String", # Required. Primary programming language of the code being optimized.
+        "runSettings": { # Run settings for the experiment. # Required. Run settings for the experiment, controlling the overall behavior of the experiment run.
+          "concurrency": 42, # Required. Maximum number of programs that can be generated in parallel. Must be positive.
+          "maxDuration": "A String", # Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.
+          "maxPrograms": 42, # Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.
+        },
+        "title": "A String", # Required. Title of the experiment.
+      },
+      "createTime": "A String", # Output only. Time when the experiment was created.
+      "initialAlphaEvolveProgram": "A String", # Output only. Specifies the name of the seed program used to start the experiment.
+      "name": "A String", # Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`
+      "state": "A String", # Output only. The state of the experiment.
+      "stats": { # Stats about the experiment. # Output only. Experiment stats.
+        "candidatesCount": 42, # Output only. Number of candidates generated.
+        "evaluatedCandidatesCount": 42, # Output only. Number of candidates evaluated.
+        "inputTokenCount": "A String", # Output only. Number of billed input tokens consumed by the experiment.
+        "outputTokenCount": "A String", # Output only. Number of billed output tokens consumed by the experiment.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ 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.
+        
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Resumes a workflow to process the AlphaEvolveExperiment.
+
+Args:
+  name: string, Required. Experiment to resume. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AlphaEvolveService.ResumeExperiment.
+}
+
+  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.
+  },
+}
+
+ +
+ start(name, body=None, x__xgafv=None) +
Starts a workflow to process the AlphaEvolveExperiment.
+
+Args:
+  name: string, Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AlphaEvolveService.StartExperiment.
+  "name": "A String", # Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`
+}
+
+  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.
+  },
+}
+
+ +
+ submitProgramsEvaluations(parent, body=None, x__xgafv=None) +
Adds an AlphaEvolveProgramEvaluation to the experiment.
+
+Args:
+  parent: string, Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for AlphaEvolveService.SubmitProgramsEvaluations.
+  "evaluationSubmissions": [ # Required. List of program evaluations to submit. At this time, only one evaluation submission is supported.
+    { # Evaluation submission for a program candidate.
+      "evaluation": { # Evaluation results for a program candidate. # Required. Evaluation results for the program candidate.
+        "insights": { # Evaluation insights for a program. # Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt.
+          "insights": [ # Optional. List of evaluation insights.
+            { # A single evaluation insight.
+              "label": "A String", # Optional. Label of the insight.
+              "text": "A String", # Optional. Text of the insight.
+            },
+          ],
+        },
+        "scores": { # Contains the evaluation scores for the target metrics to optimize. # Optional. Contains the evaluation scores for the target metrics to optimize.
+          "scores": [ # Required. List of evaluation scores.
+            { # Score for a single metric.
+              "metric": "A String", # Required. Name of the metric.
+              "score": 3.14, # Required. Score of a program for this metric.
+            },
+          ],
+        },
+      },
+      "lockToken": "A String", # Required. Lock token for the program obtained in the AcquireAlphaEvolvePrograms call.
+      "program": "A String", # Required. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`
+    },
+  ],
+}
+
+  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 AlphaEvolveService.SubmitProgramsEvaluations.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html index 43d9ece46d..e1e92b6346 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.widgetConfigs.html @@ -312,7 +312,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -327,11 +327,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -343,6 +351,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -569,7 +578,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -584,11 +593,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -600,6 +617,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -825,7 +843,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -840,11 +858,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -856,6 +882,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html index bb5f25c1bf..3d1f32446a 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html @@ -392,6 +392,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -662,6 +665,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -936,6 +942,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -1220,6 +1229,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -1514,6 +1526,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -1775,6 +1790,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html index c62978f49e..474f066034 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.html @@ -834,7 +834,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
@@ -1705,7 +1705,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. } @@ -1727,7 +1727,7 @@

Method Details

"minPrefixLength": 42, # The minimum number of characters needed to be typed in order to get suggestions. min_prefix_length must lie within the range of [1, 20]. If not set or set to 0, it will be set to the default of 1 character. "name": "A String", # Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig` "numUniqueUsersThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history, which may have user ids attached. If the number of unique users that have searched a query is less than this threshold, the query will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. - "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline. + "queryFrequencyThreshold": 42, # This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline. "queryModel": "A String", # The data model of query suggestions for serving. Currently supported values: * `automatic` - autocomplete backend automatic selects or mixes suggestions from different models. * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. If query model is empty, the serving applies the "automatic" model by default. "shouldServeContentSuggestions": True or False, # Whether to generate and serve content suggestions. This allows for content suggestions to be served in addition to query suggestions. }
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html index dd0d17edfb..8cc7b6c215 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.widgetConfigs.html @@ -312,7 +312,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -327,11 +327,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -343,6 +351,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -569,7 +578,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -584,11 +593,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -600,6 +617,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. @@ -825,7 +843,7 @@

Method Details

"enableSafeSearch": True or False, # Whether to enable safe search. "enableSearchAsYouType": True or False, # Whether to enable search-as-you-type behavior for the search widget. "enableVisualContentSummary": True or False, # If set to true, the widget will enable visual content summary on applicable search requests. Only used by healthcare search. - "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "generativeAnswerConfig": { # Describes configuration for generative answer. # Describes generative answer configuration. @@ -840,11 +858,19 @@

Method Details

"modelVersion": "A String", # The model version used to generate the answer. "resultCount": 42, # The number of top results to generate the answer from. Up to 10. }, + "googleDrivePickerEnabled": True or False, # Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above. "interactionType": "A String", # Describes widget (or web app) interaction type "modelConfigInfo": { # The resolved, server-side view of model selector configuration for the end-user. The backend computes this per-request by applying, in order: Mendel flag evaluation, regional availability rules based on the engine's location, and admin-panel overrides from `model_configs`. The backend is the single source of truth for this configuration; clients should render `resolved_models` directly in the model selector dropdown, in the order provided, without applying their own filtering, ordering, or localization. # Output only. The resolved, server-side view of model selector configuration. Holds both the ordered list of models that should appear in the model selector dropdown and the model that should be selected by default. Clients should render this directly without applying their own filtering, ordering, or localization. The legacy `model_configs` map above is retained for backward compatibility with clients that have not yet migrated to consuming this field. "defaultModelId": "A String", # Output only. The `model_id` of the model that should be selected by default in the model selector when the end-user has not made an explicit choice. The value is always one of the `model_id`s present in `resolved_models`. "resolvedModels": [ # Output only. The list of models that are available to the end-user in the model selector, in the order in which they should be displayed. { # A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata. + "adminView": { # Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry. # Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces. + "adminOverridable": True or False, # Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is "forced" and its state is governed by `enabled_by_default`. + "enabledByDefault": True or False, # Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`. + "regions": [ # Output only. Regions where this model is launched. + "A String", + ], + }, "description": "A String", # Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`. "displayName": "A String", # Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request. "icon": "A String", # Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`). @@ -856,6 +882,7 @@

Method Details

"modelConfigs": { # Output only. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. "a_key": "A String", }, + "onedrivePickerEnabled": True or False, # Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing "picker disabled" (`false`) from "field not populated" (unset). "resultDescriptionType": "A String", # Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified. "searchAddonSpec": { # SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable. # Optional. SearchAddonSpec is used to disable add-ons for search. This field is only supported for search requests. "generativeAnswerAddOnDisabled": True or False, # Optional. If true, generative answer add-on is disabled. Generative answer add-on includes natural language to filters and simple answers. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 1014f3b06c..4ee9e0f0cc 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -1260,6 +1260,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, @@ -1551,6 +1554,9 @@

Method Details

"utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }. "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. }, + "oauthStaticIpAddresses": [ # Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search. + "A String", + ], "params": { # Required data connector parameters in structured json format. "a_key": "", # Properties of the object. }, diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html index c9230c64c8..705b43e0dd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.userStores.userLicenses.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ export(parent, body=None, x__xgafv=None)

+

Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the ListUserLicenses read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data.

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the User Licenses.

@@ -89,6 +92,31 @@

Method Details

Close httplib2 connections.
+
+ export(parent, body=None, x__xgafv=None) +
Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console "Download as CSV" action: it reuses the ListUserLicenses read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data.
+
+Args:
+  parent: string, Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. All UserLicenses under this UserStore are exported. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UserLicenseService.ExportUserLicenses.
+}
+
+  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 UserLicenseService.ExportUserLicenses.
+  "csvData": "A String", # The full CSV document as raw bytes: the header row followed by one row per UserLicense. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row.
+}
+
+
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the User Licenses.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
index ffd2cce318..5f84849883 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
@@ -167,7 +167,7 @@ 

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -208,7 +208,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -258,7 +258,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -354,7 +354,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -395,7 +395,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -445,7 +445,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -517,7 +517,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -558,7 +558,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -608,7 +608,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -652,7 +652,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -693,7 +693,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -743,7 +743,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -769,7 +769,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -810,7 +810,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -860,7 +860,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -898,7 +898,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -939,7 +939,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -989,7 +989,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], @@ -1027,7 +1027,7 @@

Method Details

}, }, "appType": "A String", # Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. - "associatedAgentRegistry": "A String", # Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. + "associatedAgentRegistry": "A String", # Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry. "chatEngineConfig": { # Configurations for a Chat Engine. # Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. "agentCreationConfig": { # Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. # The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. "business": "A String", # Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. @@ -1068,7 +1068,7 @@

Method Details

], "disableAnalytics": True or False, # Optional. Whether to disable analytics for searches performed on this engine. "displayName": "A String", # Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. - "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` + "features": { # Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research` "a_key": "A String", }, "industryVertical": "A String", # Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. @@ -1118,7 +1118,7 @@

Method Details

"A String", ], "searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. - "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. + "requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. "searchAddOns": [ # The add-on that this search engine enables. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 49c1fb466c..b48f9c9c75 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -9667,7 +9667,7 @@ } } }, -"revision": "20260620", +"revision": "20260706", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "A2aV1APIKeySecurityScheme": { @@ -15294,6 +15294,14 @@ "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -16550,7 +16558,8 @@ "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -16625,7 +16634,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -16951,7 +16960,7 @@ "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -22749,7 +22758,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "readOnly": true, "type": "object" }, @@ -22757,6 +22766,11 @@ false "$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsGenerativeAnswerConfig", "description": "Describes generative answer configuration." }, +"googleDrivePickerEnabled": { +"description": "Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above.", +"readOnly": true, +"type": "boolean" +}, "interactionType": { "description": "Describes widget (or web app) interaction type", "enum": [ @@ -22796,6 +22810,11 @@ false "readOnly": true, "type": "object" }, +"onedrivePickerEnabled": { +"description": "Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing \"picker disabled\" (`false`) from \"field not populated\" (unset).", +"readOnly": true, +"type": "boolean" +}, "resultDescriptionType": { "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.", "enum": [ @@ -22898,6 +22917,11 @@ false "description": "A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.", "id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModel", "properties": { +"adminView": { +"$ref": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView", +"description": "Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces.", +"readOnly": true +}, "description": { "description": "Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`.", "readOnly": true, @@ -22926,6 +22950,31 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView": { +"description": "Admin-surface metadata. Populated only when the request originates from the Cloud Console admin \"Feature Control\" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.", +"id": "GoogleCloudDiscoveryengineV1WidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView", +"properties": { +"adminOverridable": { +"description": "Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is \"forced\" and its state is governed by `enabled_by_default`.", +"readOnly": true, +"type": "boolean" +}, +"enabledByDefault": { +"description": "Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`.", +"readOnly": true, +"type": "boolean" +}, +"regions": { +"description": "Output only. Regions where this model is launched.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1WorkspaceConfig": { "description": "Config to store data store type configuration for workspace data", "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", @@ -22954,7 +23003,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -22965,7 +23015,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -23207,6 +23258,385 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights": { +"description": "Evaluation insights for a program.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"properties": { +"insights": { +"description": "Optional. List of evaluation insights.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight": { +"description": "A single evaluation insight.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight", +"properties": { +"label": { +"description": "Optional. Label of the insight.", +"type": "string" +}, +"text": { +"description": "Optional. Text of the insight.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores": { +"description": "Contains the evaluation scores for the target metrics to optimize.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"properties": { +"scores": { +"description": "Required. List of evaluation scores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore": { +"description": "Score for a single metric.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore", +"properties": { +"metric": { +"description": "Required. Name of the metric.", +"type": "string" +}, +"score": { +"description": "Required. Score of a program for this metric.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment": { +"description": "An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment", +"properties": { +"config": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"description": "Required. Experiment configuration." +}, +"createTime": { +"description": "Output only. Time when the experiment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"initialAlphaEvolveProgram": { +"description": "Output only. Specifies the name of the seed program used to start the experiment.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the experiment.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATED", +"RUNNING", +"PAUSED", +"COMPLETED", +"FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The experiment is created.", +"The experiment is running.", +"The experiment is paused.", +"The experiment is completed.", +"The experiment has failed." +], +"readOnly": true, +"type": "string" +}, +"stats": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", +"description": "Output only. Experiment stats.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig": { +"description": "Configuration of an experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"properties": { +"evolutionSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"description": "Optional. Evolution settings for the experiment." +}, +"generationSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"description": "Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts." +}, +"problemDescription": { +"description": "Required. Description of the problem to be solved by the experiment.", +"type": "string" +}, +"programLanguage": { +"description": "Required. Primary programming language of the code being optimized.", +"type": "string" +}, +"runSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"description": "Required. Run settings for the experiment, controlling the overall behavior of the experiment run." +}, +"title": { +"description": "Required. Title of the experiment.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings": { +"description": "Evolution settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"properties": { +"parentSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"description": "Optional. Parent sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig": { +"description": "Configuration for parent sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"properties": { +"paretoSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"description": "Optional. Pareto sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig": { +"description": "Configuration for Pareto sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"properties": { +"paretoSamplingProbability": { +"description": "Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings": { +"description": "Generation settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"properties": { +"context": { +"description": "Optional. Additional user-provided context to be used during generation.", +"type": "string" +}, +"includeFullProgramInPrompt": { +"description": "Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.", +"type": "boolean" +}, +"models": { +"description": "Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig": { +"description": "Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig", +"properties": { +"name": { +"description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", +"type": "string" +}, +"weight": { +"description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings": { +"description": "Run settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"properties": { +"concurrency": { +"description": "Required. Maximum number of programs that can be generated in parallel. Must be positive.", +"format": "int32", +"type": "integer" +}, +"maxDuration": { +"description": "Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.", +"format": "google-duration", +"type": "string" +}, +"maxPrograms": { +"description": "Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats": { +"description": "Stats about the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", +"properties": { +"candidatesCount": { +"description": "Output only. Number of candidates generated.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"evaluatedCandidatesCount": { +"description": "Output only. Number of candidates evaluated.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"inputTokenCount": { +"description": "Output only. Number of billed input tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"outputTokenCount": { +"description": "Output only. Number of billed output tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram": { +"description": "Represents a single program to be used within the context of an AlphaEvolve experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", +"description": "Optional. Content of the program." +}, +"createTime": { +"description": "Output only. Time when the program was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"evaluation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"description": "Optional. Evaluation results for the program." +}, +"lockToken": { +"description": "Optional. Lock token for the program.", +"type": "string" +}, +"name": { +"description": "Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"type": "string" +}, +"parentPrograms": { +"description": "Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. State of the program.", +"enum": [ +"PROGRAM_STATE_UNSPECIFIED", +"INITIALIZED", +"GENERATING", +"EVALUATING", +"COMPLETED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The program is initialized.", +"The program is in generation.", +"The program is pending evaluation.", +"The program is completed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent": { +"description": "A self-contained message containing the content of a program. Can represent a collection of files.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", +"properties": { +"description": { +"description": "Optional. Description of the program.", +"type": "string" +}, +"files": { +"description": "Required. A list of source files that make up the overall program.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation": { +"description": "Evaluation results for a program candidate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"properties": { +"insights": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"description": "Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt." +}, +"scores": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"description": "Optional. Contains the evaluation scores for the target metrics to optimize." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile": { +"description": "A single source file with its path, content and metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile", +"properties": { +"content": { +"description": "Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.", +"type": "string" +}, +"description": { +"description": "Optional. Additional description of the file.", +"type": "string" +}, +"path": { +"description": "Required. The relative path of the file, including the filename. e.g., \"src/main.py\", \"utils/helpers.js\", \"README.md\"", +"type": "string" +}, +"programLanguage": { +"description": "Optional. The programming language of the file.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -25463,6 +25893,14 @@ false "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -26303,6 +26741,11 @@ false "description": "The number of end users under the user store that were successfully deleted.", "format": "int64", "type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" @@ -26591,7 +27034,8 @@ false "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -26666,7 +27110,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -27057,7 +27501,7 @@ false "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -29058,6 +29502,25 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.ResumeExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -30417,6 +30880,36 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.StartExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStartExperimentRequest": { +"description": "Request message for AlphaEvolveService.StartExperiment.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest", +"properties": { +"name": { +"description": "Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaTargetSite": { "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", @@ -30818,7 +31311,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -30829,7 +31323,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -32114,7 +32609,8 @@ false "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -32189,7 +32685,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -32515,7 +33011,7 @@ false "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -35236,7 +35732,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -35247,7 +35744,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 086d4967a0..a423bc1efb 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -7414,144 +7414,180 @@ }, "resources": { "alphaEvolveExperiments": { -"resources": { -"operations": { "methods": { -"get": { -"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations.get", +"acquirePrograms": { +"description": "Acquires one or more AlphaEvolveProgram from the generated queue of programs for evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:acquirePrograms", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.acquirePrograms", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveExperiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}:acquirePrograms", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"create": { +"description": "Creates a new AlphaEvolveExperiment.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name (Session) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/alphaEvolveExperiments", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"delete": { +"description": "Deletes an experiment provided the experiment is in an end state (e.g. created, failed, succeeded).", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The full resource name of the experiment to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} -} -} -} }, -"answers": { -"methods": { "get": { -"description": "Gets a Answer.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", +"description": "Get an existing Experiment.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", +"description": "Required. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} -} }, -"files": { -"methods": { "list": { -"description": "Lists metadata for all files in the current session.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/files", +"description": "List all AlphaEvolveExperiments in a given session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.engines.sessions.files.list", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.list", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * \"file_name = 'file_1'\" * \"file_name = 'file_1' AND mime_type = 'text/plain'\" * \"last_use_time > '2025-06-14T12:00:00Z'\" For a full description of the filter format, please see https://google.aip.dev/160.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time`", -"location": "query", -"type": "string" -}, "pageSize": { -"description": "Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error.", +"description": "Optional. The maximum number of experiments to return. The service may return fewer than this value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ).", +"description": "Optional. A page token, received from a previous `ListAlphaEvolveExperiments` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` Name of the session resource to which the file belong.", +"description": "Required. The parent resource name (Session) of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/files", +"path": "v1alpha/{+parent}/alphaEvolveExperiments", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaListFilesResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} -} }, -"operations": { -"methods": { -"get": { -"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.engines.sessions.operations.get", +"resume": { +"description": "Resumes a workflow to process the AlphaEvolveExperiment.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:resume", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.resume", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. Experiment to resume. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+name}:resume", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest" +}, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -7560,119 +7596,121 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} -} -} -} }, -"widgetConfigs": { -"methods": { -"get": { -"description": "Gets a WidgetConfig.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get", +"start": { +"description": "Starts a workflow to process the AlphaEvolveExperiment.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:start", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.start", "parameterOrder": [ "name" ], "parameters": { -"acceptCache": { -"description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", -"location": "query", -"type": "boolean" -}, -"getWidgetConfigRequestOption.turnOffCollectionComponents": { -"description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", -"location": "query", -"type": "boolean" -}, -"languageCode": { -"description": "Optional. BCP-47 language tag (e.g. \"en\", \"fr-CA\"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", +"description": "Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+name}:start", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"patch": { -"description": "Update a WidgetConfig.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", -"httpMethod": "PATCH", -"id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", +"submitProgramsEvaluations": { +"description": "Adds an AlphaEvolveProgramEvaluation to the experiment.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}:submitProgramsEvaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.submitProgramsEvaluations", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"parent": { +"description": "Required. The parent resource name (AlphaEvolveExperiment) of the Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}:submitProgramsEvaluations", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +"$ref": "GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +"$ref": "GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } -} -} -} }, -"operations": { +"resources": { +"alphaEvolvePrograms": { "methods": { +"create": { +"description": "Creates a new AlphaEvolveProgram.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name (AlphaEvolveExperiment) of the AlphaEvolveProgram. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/alphaEvolvePrograms", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "get": { -"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", +"description": "Gets an existing AlphaEvolveProgram.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms/{alphaEvolveProgramsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.get", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The full resource name of the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+/alphaEvolvePrograms/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7681,46 +7719,60 @@ ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", +"description": "List all AlphaEvolvePrograms in a given experiment that follow the criteria provided in the request.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/alphaEvolvePrograms", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.collections.operations.list", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.alphaEvolvePrograms.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", +"orderBy": { +"description": "Optional. Sorting criterion for the programs. Comma separated list of metrics to sort by and optionally sort order, e.g. \"score1 desc, score2\". The criteria are applied in the order listed in the field. An implicit criterion of sorting by create_time descending is always applied as the final tie-breaker after all other specified criteria.", "location": "query", "type": "string" }, -"name": { -"description": "The name of the operation's parent resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", -"required": true, -"type": "string" -}, "pageSize": { -"description": "The standard list page size.", +"description": "Optional. The maximum number of programs to return. The service may return fewer than this value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "Optional. A page token, received from a previous `ListAlphaEvolvePrograms` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, -"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.", +"parent": { +"description": "Required. The parent resource name (AlphaEvolveExperiment) of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+$", +"required": true, +"type": "string" +}, +"stateFilter": { +"description": "Optional. Filter to apply to the programs. Examples: \"state_filter = \\'COMPLETED\\'\" \"state_filter = \\'INITIALIZED\\' OR \"state_filter = \\'EVALUATING\\'\" If empty, the behavior defaults to listing programs in REGISTRATION_COMPLETE state or processing state is NULL.", +"enum": [ +"PROGRAM_STATE_UNSPECIFIED", +"INITIALIZED", +"GENERATING", +"EVALUATING", +"COMPLETED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The program is initialized.", +"The program is in generation.", +"The program is pending evaluation.", +"The program is completed." +], "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1alpha/{+name}/operations", +"path": "v1alpha/{+parent}/alphaEvolvePrograms", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7729,32 +7781,27 @@ ] } } -} -} }, -"dataStores": { +"operations": { "methods": { -"addPatientFilter": { -"description": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:addPatientFilter", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.addPatientFilter", +"get": { +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/alphaEvolveExperiments/{alphaEvolveExperimentsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.alphaEvolveExperiments.operations.get", "parameterOrder": [ -"dataStore" +"name" ], "parameters": { -"dataStore": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"name": { +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/alphaEvolveExperiments/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+dataStore}:addPatientFilter", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" -}, +"path": "v1alpha/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -7763,103 +7810,85 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} +} +} +} }, -"completeQuery": { -"description": "Completes the specified user input with keyword suggestions.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery", +"answers": { +"methods": { +"get": { +"description": "Gets a Answer.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/answers/{answersId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.completeQuery", +"id": "discoveryengine.projects.locations.collections.engines.sessions.answers.get", "parameterOrder": [ -"dataStore" +"name" ], "parameters": { -"dataStore": { -"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.", +"name": { +"description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, "type": "string" -}, -"includeTailSuggestions": { -"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", -"location": "query", -"type": "boolean" -}, -"query": { -"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", -"location": "query", -"type": "string" -}, -"queryModel": { -"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", -"location": "query", -"type": "string" -}, -"userPseudoId": { -"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", -"location": "query", -"type": "string" } }, -"path": "v1alpha/{+dataStore}:completeQuery", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswer" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} +} }, -"create": { -"description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.create", +"files": { +"methods": { +"list": { +"description": "Lists metadata for all files in the current session.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/files", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.files.list", "parameterOrder": [ "parent" ], "parameters": { -"cmekConfigName": { -"description": "Resource name of the CmekConfig to use for protecting this DataStore.", +"filter": { +"description": "Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * \"file_name = 'file_1'\" * \"file_name = 'file_1' AND mime_type = 'text/plain'\" * \"last_use_time > '2025-06-14T12:00:00Z'\" For a full description of the filter format, please see https://google.aip.dev/160.", "location": "query", "type": "string" }, -"createAdvancedSiteSearch": { -"description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", +"orderBy": { +"description": "Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with ` desc`. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * `upload_time`: The time the file was uploaded. * `file_name`: The name of the file. * `mime_type`: The MIME type of the file. * `session_name`: The name of the session the file belongs to. Default Behavior: If the `order_by` field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: `file_name` 2. Sort by upload time in descending order: `upload_time desc` 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): `file_name, mime_type desc, upload_time`", "location": "query", -"type": "boolean" +"type": "string" }, -"dataStoreId": { -"description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"pageSize": { +"description": "Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error.", +"format": "int32", "location": "query", -"type": "string" +"type": "integer" }, -"disableCmek": { -"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"pageToken": { +"description": "Optional. A page token received from a previous `ListFiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFiles` must match the call that provided the page token (except `page_size`, which may differ).", "location": "query", -"type": "boolean" +"type": "string" }, "parent": { -"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", +"description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` Name of the session resource to which the file belong.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, "type": "string" -}, -"skipDefaultSchemaCreation": { -"description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", -"location": "query", -"type": "boolean" } }, -"path": "v1alpha/{+parent}/dataStores", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" -}, +"path": "v1alpha/{+parent}/files", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaListFilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7867,20 +7896,24 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} +} }, -"delete": { -"description": "Deletes a DataStore.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", -"httpMethod": "DELETE", -"id": "discoveryengine.projects.locations.dataStores.delete", +"operations": { +"methods": { +"get": { +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.sessions.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7891,61 +7924,88 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} +} +} +} }, -"deletePatientFilter": { -"description": "Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:deletePatientFilter", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.deletePatientFilter", +"widgetConfigs": { +"methods": { +"get": { +"description": "Gets a WidgetConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.get", "parameterOrder": [ -"dataStore" +"name" ], "parameters": { -"dataStore": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", +"acceptCache": { +"description": "Optional. Whether it's acceptable to load the widget config from cache. If set to true, recent changes on widget configs may take a few minutes to reflect on the end user's view. It's recommended to set to true for maturely developed widgets, as it improves widget performance. Set to false to see changes reflected in prod right away, if your widget is under development.", +"location": "query", +"type": "boolean" +}, +"getWidgetConfigRequestOption.turnOffCollectionComponents": { +"description": "Optional. Whether to turn off collection_components in WidgetConfig to reduce latency and data transmission.", +"location": "query", +"type": "boolean" +}, +"languageCode": { +"description": "Optional. BCP-47 language tag (e.g. \"en\", \"fr-CA\"). Used to localize human-readable strings in the response, such as the model selector `display_name` / `description` on `WidgetConfig.UiSettings.ModelConfigInfo`. Empty / unset falls back to the default language (English).", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Full WidgetConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+dataStore}:deletePatientFilter", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" -}, +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"get": { -"description": "Gets a DataStore.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.get", +"patch": { +"description": "Update a WidgetConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/widgetConfigs/{widgetConfigsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.collections.engines.widgetConfigs.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.", +"description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/widgetConfigs/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7953,27 +8013,33 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} +} +} +} }, -"getCompletionConfig": { -"description": "Gets a CompletionConfig", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig", +"operations": { +"methods": { +"get": { +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.getCompletionConfig", +"id": "discoveryengine.projects.locations.collections.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig`", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCompletionConfig" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -7981,159 +8047,242 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"getDocumentProcessingConfig": { -"description": "Gets a DocumentProcessingConfig.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/operations", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.getDocumentProcessingConfig", +"id": "discoveryengine.projects.locations.collections.operations.list", "parameterOrder": [ "name" ], "parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, "name": { -"description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +}, +"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.", +"location": "query", +"type": "boolean" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+name}/operations", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -}, -"getSiteSearchEngine": { -"description": "Gets the SiteSearchEngine.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", +} +} +} +} +}, +"dataStores": { +"methods": { +"addPatientFilter": { +"description": "Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:addPatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.addPatientFilter", +"parameterOrder": [ +"dataStore" +], +"parameters": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+dataStore}:addPatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"completeQuery": { +"description": "Completes the specified user input with keyword suggestions.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:completeQuery", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.getSiteSearchEngine", +"id": "discoveryengine.projects.locations.dataStores.completeQuery", "parameterOrder": [ -"name" +"dataStore" ], "parameters": { -"name": { -"description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", +"dataStore": { +"description": "Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" +}, +"includeTailSuggestions": { +"description": "Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.", +"location": "query", +"type": "boolean" +}, +"query": { +"description": "Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.", +"location": "query", +"type": "string" +}, +"queryModel": { +"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", +"location": "query", +"type": "string" +}, +"userPseudoId": { +"description": "Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+dataStore}:completeQuery", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" +"$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"list": { -"description": "Lists all the DataStores associated with the project.", +"create": { +"description": "Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.list", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.create", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`", +"cmekConfigName": { +"description": "Resource name of the CmekConfig to use for protecting this DataStore.", "location": "query", "type": "string" }, -"pageSize": { -"description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.", -"format": "int32", +"createAdvancedSiteSearch": { +"description": "A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.", "location": "query", -"type": "integer" +"type": "boolean" }, -"pageToken": { -"description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", +"dataStoreId": { +"description": "Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string" }, +"disableCmek": { +"description": "DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well.", +"location": "query", +"type": "boolean" +}, "parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.", +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"skipDefaultSchemaCreation": { +"description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", +"location": "query", +"type": "boolean" } }, "path": "v1alpha/{+parent}/dataStores", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"patch": { -"description": "Updates a DataStore", +"delete": { +"description": "Deletes a DataStore.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", -"httpMethod": "PATCH", -"id": "discoveryengine.projects.locations.dataStores.patch", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.dataStores.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1alpha/{+name}", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" -}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"removePatientFilter": { -"description": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:removePatientFilter", +"deletePatientFilter": { +"description": "Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:deletePatientFilter", "httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.removePatientFilter", +"id": "discoveryengine.projects.locations.dataStores.deletePatientFilter", "parameterOrder": [ "dataStore" ], "parameters": { "dataStore": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+dataStore}:removePatientFilter", +"path": "v1alpha/{+dataStore}:deletePatientFilter", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" +"$ref": "GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -8144,63 +8293,52 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"replacePatientFilter": { -"description": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:replacePatientFilter", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.replacePatientFilter", +"get": { +"description": "Gets a DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.get", "parameterOrder": [ -"dataStore" +"name" ], "parameters": { -"dataStore": { -"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", +"name": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+dataStore}:replacePatientFilter", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" -}, +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"updateCompletionConfig": { -"description": "Updates the CompletionConfigs.", +"getCompletionConfig": { +"description": "Gets a CompletionConfig", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig", -"httpMethod": "PATCH", -"id": "discoveryengine.projects.locations.dataStores.updateCompletionConfig", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.getCompletionConfig", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig`", +"description": "Required. Full CompletionConfig resource name. Format: `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1alpha/{+name}", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCompletionConfig" -}, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionConfig" }, @@ -8210,33 +8348,24 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"updateDocumentProcessingConfig": { -"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.", +"getDocumentProcessingConfig": { +"description": "Gets a DocumentProcessingConfig.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", -"httpMethod": "PATCH", -"id": "discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.getDocumentProcessingConfig", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "v1alpha/{+name}", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" -}, "response": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, @@ -8245,43 +8374,27 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} }, -"resources": { -"branches": { -"methods": { -"batchGetDocumentsMetadata": { -"description": "Gets index freshness metadata for Documents. Supported for website search only.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"getSiteSearchEngine": { +"description": "Gets the SiteSearchEngine.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", +"id": "discoveryengine.projects.locations.dataStores.getSiteSearchEngine", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"matcher.fhirMatcher.fhirResources": { -"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", -"location": "query", -"repeated": true, -"type": "string" -}, -"matcher.urisMatcher.uris": { -"description": "The exact URIs to match by.", -"location": "query", -"repeated": true, -"type": "string" -}, -"parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"name": { +"description": "Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", "required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/batchGetDocumentsMetadata", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8289,41 +8402,42 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"get": { -"description": "Retrieves a Branch.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.get", +"list": { +"description": "Lists all the DataStores associated with the project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", -"required": true, +"filter": { +"description": "Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`", +"location": "query", "type": "string" }, -"view": { -"description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", -"enum": [ -"BRANCH_VIEW_UNSPECIFIED", -"BRANCH_VIEW_BASIC", -"BRANCH_VIEW_FULL" -], -"enumDescriptions": [ -"The value when it's unspecified. This defaults to the BASIC view.", -"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", -"Includes all fields of a Branch." -], +"pageSize": { +"description": "Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.", "location": "query", "type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}/dataStores", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaBranch" +"$ref": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8331,80 +8445,65 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"list": { -"description": "Lists all Branchs under the specified parent DataStore.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.list", +"patch": { +"description": "Updates a DataStore", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent data store resource name.", +"name": { +"description": "Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" }, -"view": { -"description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", -"enum": [ -"BRANCH_VIEW_UNSPECIFIED", -"BRANCH_VIEW_BASIC", -"BRANCH_VIEW_FULL" -], -"enumDescriptions": [ -"The value when it's unspecified. This defaults to the BASIC view.", -"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", -"Includes all fields of a Branch." -], +"updateMask": { +"description": "Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1alpha/{+parent}/branches", +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} }, -"resources": { -"documents": { -"methods": { -"create": { -"description": "Creates a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", +"removePatientFilter": { +"description": "Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:removePatientFilter", "httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.create", +"id": "discoveryengine.projects.locations.dataStores.removePatientFilter", "parameterOrder": [ -"parent" +"dataStore" ], "parameters": { -"documentId": { -"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/documents", +"path": "v1alpha/{+dataStore}:removePatientFilter", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +"$ref": "GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8412,26 +8511,29 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"delete": { -"description": "Deletes a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", -"httpMethod": "DELETE", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.delete", +"replacePatientFilter": { +"description": "Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}:replacePatientFilter", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.replacePatientFilter", "parameterOrder": [ -"name" +"dataStore" ], "parameters": { -"name": { -"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+dataStore}:replacePatientFilter", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest" +}, "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8439,26 +8541,35 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"get": { -"description": "Gets a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.get", +"updateCompletionConfig": { +"description": "Updates the CompletionConfigs.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/completionConfig", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.updateCompletionConfig", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", +"description": "Required. Immutable. Fully qualified name `projects/*/locations/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/dataStores/*/completionConfig` `projects/*/locations/*/collections/*/engines/*/completionConfig`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/completionConfig$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided CompletionConfig to update. The following are the only supported fields: * CompletionConfig.matching_order * CompletionConfig.max_suggestions * CompletionConfig.min_prefix_length * CompletionConfig.query_model * CompletionConfig.enable_mode * CompletionConfig.query_frequency_threshold * CompletionConfig.num_unique_users_threshold * CompletionConfig.should_serve_content_suggestions * CompletionConfig.filter_pii_suggestions_using_dlp If not set, all supported fields are updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCompletionConfig" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +"$ref": "GoogleCloudDiscoveryengineV1alphaCompletionConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8466,93 +8577,78 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"getProcessedDocument": { -"description": "Gets the parsed layout information for a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument", +"updateDocumentProcessingConfig": { +"description": "Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/documentProcessingConfig", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.updateDocumentProcessingConfig", "parameterOrder": [ "name" ], "parameters": { -"imageId": { -"description": "Optional. Specifies config for IMAGE_BYTES.", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "required": true, "type": "string" }, -"processedDocumentFormat": { -"description": "What format output should be. If unspecified, defaults to JSON.", -"enum": [ -"PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", -"JSON" -], -"enumDescriptions": [ -"Default value.", -"Output format is a JSON string representation of processed document." -], -"location": "query", -"type": "string" -}, -"processedDocumentType": { -"description": "Required. What type of processing to return.", -"enum": [ -"PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", -"PARSED_DOCUMENT", -"CHUNKED_DOCUMENT", -"IMAGE_CONVERTED_DOCUMENT", -"IMAGE_BYTES" -], -"enumDescriptions": [ -"Default value.", -"Available for all data store parsing configs.", -"Only available if ChunkingConfig is enabled on the data store.", -"Returns the converted Image bytes (as JPEG or PNG) if available.", -"Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." -], +"updateMask": { +"description": "Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated.", +"format": "google-fieldmask", "location": "query", "type": "string" } }, -"path": "v1alpha/{+name}:getProcessedDocument", +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" +}, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} }, -"import": { -"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.import", +"resources": { +"branches": { +"methods": { +"batchGetDocumentsMetadata": { +"description": "Gets index freshness metadata for Documents. Supported for website search only.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", "parameterOrder": [ "parent" ], "parameters": { +"matcher.fhirMatcher.fhirResources": { +"description": "Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}", +"location": "query", +"repeated": true, +"type": "string" +}, +"matcher.urisMatcher.uris": { +"description": "The exact URIs to match by.", +"location": "query", +"repeated": true, +"type": "string" +}, "parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.", +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/documents:import", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest" -}, +"path": "v1alpha/{+parent}/batchGetDocumentsMetadata", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8560,37 +8656,41 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"list": { -"description": "Gets a list of Documents.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", +"get": { +"description": "Retrieves a Branch.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.list", +"id": "discoveryengine.projects.locations.dataStores.branches.get", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"pageSize": { -"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", +"name": { +"description": "Required. The name of the branch to retrieve. Format: `projects/*/locations/global/dataStores/default_data_store/branches/some_branch_id`. \"default_branch\" can be used as a special branch_id, it returns the default branch that has been set for the document.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], +"location": "query", +"type": "string" } }, -"path": "v1alpha/{+parent}/documents", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaBranch" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8598,56 +8698,66 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"patch": { -"description": "Updates a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", -"httpMethod": "PATCH", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.patch", +"list": { +"description": "Lists all Branchs under the specified parent DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"allowMissing": { -"description": "If set to `true` and the Document is not found, a new Document is be created.", -"location": "query", -"type": "boolean" -}, -"name": { -"description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"parent": { +"description": "Required. The parent data store resource name.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, "type": "string" }, -"updateMask": { -"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", -"format": "google-fieldmask", +"view": { +"description": "The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.", +"enum": [ +"BRANCH_VIEW_UNSPECIFIED", +"BRANCH_VIEW_BASIC", +"BRANCH_VIEW_FULL" +], +"enumDescriptions": [ +"The value when it's unspecified. This defaults to the BASIC view.", +"Includes basic metadata about the branch, but not statistical fields. See documentation of individual fields of Branch to know what is excluded.", +"Includes all fields of a Branch." +], "location": "query", "type": "string" } }, -"path": "v1alpha/{+name}", -"request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" -}, +"path": "v1alpha/{+parent}/branches", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +"$ref": "GoogleCloudDiscoveryengineV1alphaListBranchesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] +} }, -"purge": { -"description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", +"resources": { +"documents": { +"methods": { +"create": { +"description": "Creates a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.purge", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.create", "parameterOrder": [ "parent" ], "parameters": { +"documentId": { +"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, "parent": { "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", "location": "path", @@ -8656,43 +8766,39 @@ "type": "string" } }, -"path": "v1alpha/{+parent}/documents:purge", +"path": "v1alpha/{+parent}/documents", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} }, -"resources": { -"chunks": { -"methods": { -"get": { -"description": "Gets a Document.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.get", +"delete": { +"description": "Deletes a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.delete", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", +"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaChunk" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8700,73 +8806,90 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"list": { -"description": "Gets a list of Chunks.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", +"get": { +"description": "Gets a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.list", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.get", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"pageSize": { -"description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", +"name": { +"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/chunks", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite", "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] -} -} -} -} }, -"operations": { -"methods": { -"cancel": { -"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", +"getProcessedDocument": { +"description": "Gets the parsed layout information for a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}:getProcessedDocument", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.getProcessedDocument", "parameterOrder": [ "name" ], "parameters": { +"imageId": { +"description": "Optional. Specifies config for IMAGE_BYTES.", +"location": "query", +"type": "string" +}, "name": { -"description": "The name of the operation resource to be cancelled.", +"description": "Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", "required": true, "type": "string" -} }, -"path": "v1alpha/{+name}:cancel", -"request": { -"$ref": "GoogleLongrunningCancelOperationRequest" +"processedDocumentFormat": { +"description": "What format output should be. If unspecified, defaults to JSON.", +"enum": [ +"PROCESSED_DOCUMENT_FORMAT_UNSPECIFIED", +"JSON" +], +"enumDescriptions": [ +"Default value.", +"Output format is a JSON string representation of processed document." +], +"location": "query", +"type": "string" +}, +"processedDocumentType": { +"description": "Required. What type of processing to return.", +"enum": [ +"PROCESSED_DOCUMENT_TYPE_UNSPECIFIED", +"PARSED_DOCUMENT", +"CHUNKED_DOCUMENT", +"IMAGE_CONVERTED_DOCUMENT", +"IMAGE_BYTES" +], +"enumDescriptions": [ +"Default value.", +"Available for all data store parsing configs.", +"Only available if ChunkingConfig is enabled on the data store.", +"Returns the converted Image bytes (as JPEG or PNG) if available.", +"Return image bytes in base64 encoded format if image_id of a document is provided, only supported for enabling shareholder-structure in layout parsing config for now." +], +"location": "query", +"type": "string" +} }, +"path": "v1alpha/{+name}:getProcessedDocument", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudDiscoveryengineV1alphaProcessedDocument" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8774,24 +8897,27 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, -"get": { -"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.operations.get", +"import": { +"description": "Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.import", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", "required": true, "type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}/documents:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest" +}, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -8802,10 +8928,251 @@ ] }, "list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", +"description": "Gets a list of Documents.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.dataStores.branches.operations.list", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/documents", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"patch": { +"description": "Updates a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"allowMissing": { +"description": "If set to `true` and the Document is not found, a new Document is be created.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocument" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"purge": { +"description": "Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:purge", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.purge", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/documents:purge", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +} +}, +"resources": { +"chunks": { +"methods": { +"get": { +"description": "Gets a Document.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks/{chunksId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Chunk, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+/chunks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaChunk" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"list": { +"description": "Gets a list of Chunks.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}/chunks", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.documents.chunks.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/chunks", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListChunksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +} +} +} +} +}, +"operations": { +"methods": { +"cancel": { +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource to be cancelled.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:cancel", +"request": { +"$ref": "GoogleLongrunningCancelOperationRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"get": { +"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": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.dataStores.branches.operations.list", "parameterOrder": [ "name" ], @@ -12759,21 +13126,51 @@ }, "userLicenses": { "methods": { -"list": { -"description": "Lists the User Licenses.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.userStores.userLicenses.list", +"export": { +"description": "Exports all the UserLicenses under the parent UserStore as a single CSV document. This is the backend for the admin console \"Download as CSV\" action: it reuses the ListUserLicenses read path so admins can sort/filter offline in Excel or Sheets. The response carries the full CSV (header row followed by data rows) inline in ExportUserLicensesResponse.csv_data.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses:export", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userStores.userLicenses.export", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`.", -"location": "query", +"parent": { +"description": "Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. All UserLicenses under this UserStore are exported.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+$", +"required": true, "type": "string" +} }, -"orderBy": { +"path": "v1alpha/{+parent}/userLicenses:export", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"list": { +"description": "Lists the User Licenses.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/userLicenses", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userStores.userLicenses.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`.", +"location": "query", +"type": "string" +}, +"orderBy": { "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order.", "location": "query", "type": "string" @@ -12895,7 +13292,7 @@ } } }, -"revision": "20260620", +"revision": "20260706", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -14611,6 +15008,14 @@ "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -15625,7 +16030,8 @@ "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -15700,7 +16106,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -16026,7 +16432,7 @@ "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -17785,7 +18191,8 @@ "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -17796,7 +18203,8 @@ "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -17879,6 +18287,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest": { +"description": "Request message for AlphaEvolveService.AcquirePrograms.", +"id": "GoogleCloudDiscoveryengineV1alphaAcquireProgramsRequest", +"properties": { +"desiredProgramsCount": { +"description": "Optional. Number of evolved programs to acquire. If not set, the default value is 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse": { +"description": "Response message for AlphaEvolveService.AcquirePrograms.", +"id": "GoogleCloudDiscoveryengineV1alphaAcquireProgramsResponse", +"properties": { +"programs": { +"description": "Output only. List of acquired program candidates to be evaluated. Note: The number of programs acquired might be lower than requested.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaActionConfig": { "description": "Informations to support actions on the connector.", "id": "GoogleCloudDiscoveryengineV1alphaActionConfig", @@ -18511,140 +18946,538 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { -"description": "The connector level alert config.", -"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", +"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": { +"description": "The connector level alert config.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment states of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicyName": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATES_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { +"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"properties": { +"alertEnrollments": { +"description": "Optional. The enrollment state of each alert.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" +}, +"type": "array" +}, +"alertPolicy": { +"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"type": "string" +}, +"contactDetails": { +"description": "Optional. The contact details for each alert policy.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" +}, +"type": "array" +}, +"languageCode": { +"description": "Optional. The language code used for notifications", +"type": "string" +}, +"regionCode": { +"description": "Optional. The region code used of the user that subscribed to the alert policy.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { +"description": "The alert enrollment status.", +"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", +"properties": { +"alertId": { +"description": "Immutable. The id of an alert.", +"type": "string" +}, +"enrollState": { +"description": "Required. The enrollment status of a customer.", +"enum": [ +"ENROLL_STATE_UNSPECIFIED", +"ENROLLED", +"DECLINED" +], +"enumDescriptions": [ +"Default value. Used for customers who have not responded to the alert policy.", +"Customer is enrolled in this policy.", +"Customer declined this policy." +], +"type": "string" +}, +"notificationParams": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { +"description": "AlloyDB source import data from.", +"id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", +"properties": { +"clusterId": { +"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"databaseId": { +"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"gcsStagingDir": { +"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", +"type": "string" +}, +"locationId": { +"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", +"type": "string" +}, +"projectId": { +"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"type": "string" +}, +"tableId": { +"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights": { +"description": "Evaluation insights for a program.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"properties": { +"insights": { +"description": "Optional. List of evaluation insights.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight": { +"description": "A single evaluation insight.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight", +"properties": { +"label": { +"description": "Optional. Label of the insight.", +"type": "string" +}, +"text": { +"description": "Optional. Text of the insight.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores": { +"description": "Contains the evaluation scores for the target metrics to optimize.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"properties": { +"scores": { +"description": "Required. List of evaluation scores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore": { +"description": "Score for a single metric.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore", +"properties": { +"metric": { +"description": "Required. Name of the metric.", +"type": "string" +}, +"score": { +"description": "Required. Score of a program for this metric.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment": { +"description": "An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment", +"properties": { +"config": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"description": "Required. Experiment configuration." +}, +"createTime": { +"description": "Output only. Time when the experiment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"initialAlphaEvolveProgram": { +"description": "Output only. Specifies the name of the seed program used to start the experiment.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the experiment.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATED", +"RUNNING", +"PAUSED", +"COMPLETED", +"FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The experiment is created.", +"The experiment is running.", +"The experiment is paused.", +"The experiment is completed.", +"The experiment has failed." +], +"readOnly": true, +"type": "string" +}, +"stats": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", +"description": "Output only. Experiment stats.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig": { +"description": "Configuration of an experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"properties": { +"evolutionSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"description": "Optional. Evolution settings for the experiment." +}, +"generationSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"description": "Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts." +}, +"problemDescription": { +"description": "Required. Description of the problem to be solved by the experiment.", +"type": "string" +}, +"programLanguage": { +"description": "Required. Primary programming language of the code being optimized.", +"type": "string" +}, +"runSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"description": "Required. Run settings for the experiment, controlling the overall behavior of the experiment run." +}, +"title": { +"description": "Required. Title of the experiment.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings": { +"description": "Evolution settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"properties": { +"parentSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"description": "Optional. Parent sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig": { +"description": "Configuration for parent sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"properties": { +"paretoSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"description": "Optional. Pareto sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig": { +"description": "Configuration for Pareto sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"properties": { +"paretoSamplingProbability": { +"description": "Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings": { +"description": "Generation settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"properties": { +"context": { +"description": "Optional. Additional user-provided context to be used during generation.", +"type": "string" +}, +"includeFullProgramInPrompt": { +"description": "Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.", +"type": "boolean" +}, +"models": { +"description": "Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig": { +"description": "Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig", +"properties": { +"name": { +"description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", +"type": "string" +}, +"weight": { +"description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings": { +"description": "Run settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"properties": { +"concurrency": { +"description": "Required. Maximum number of programs that can be generated in parallel. Must be positive.", +"format": "int32", +"type": "integer" +}, +"maxDuration": { +"description": "Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.", +"format": "google-duration", +"type": "string" +}, +"maxPrograms": { +"description": "Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats": { +"description": "Stats about the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", "properties": { -"alertEnrollments": { -"description": "Optional. The enrollment states of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment" +"candidatesCount": { +"description": "Output only. Number of candidates generated.", +"format": "int32", +"readOnly": true, +"type": "integer" }, -"type": "array" +"evaluatedCandidatesCount": { +"description": "Output only. Number of candidates evaluated.", +"format": "int32", +"readOnly": true, +"type": "integer" }, -"alertPolicyName": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"inputTokenCount": { +"description": "Output only. Number of billed input tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"outputTokenCount": { +"description": "Output only. Number of billed output tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment", +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram": { +"description": "Represents a single program to be used within the context of an AlphaEvolve experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram", "properties": { -"alertId": { -"description": "Immutable. The id of an alert.", +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", +"description": "Optional. Content of the program." +}, +"createTime": { +"description": "Output only. Time when the program was created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"enrollState": { -"description": "Required. The enrollment status of a customer.", +"evaluation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"description": "Optional. Evaluation results for the program." +}, +"lockToken": { +"description": "Optional. Lock token for the program.", +"type": "string" +}, +"name": { +"description": "Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"type": "string" +}, +"parentPrograms": { +"description": "Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. State of the program.", "enum": [ -"ENROLL_STATES_UNSPECIFIED", -"ENROLLED", -"DECLINED" +"PROGRAM_STATE_UNSPECIFIED", +"INITIALIZED", +"GENERATING", +"EVALUATING", +"COMPLETED" ], "enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." +"Default value. This value is unused.", +"The program is initialized.", +"The program is in generation.", +"The program is pending evaluation.", +"The program is completed." ], +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig": { -"description": "The resource level alert config. Used in: * UserLicense * EngineUserData The AlertPolicyConfig in data connector is of same usage. No easy way to migrate.", -"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfig", +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent": { +"description": "A self-contained message containing the content of a program. Can represent a collection of files.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", "properties": { -"alertEnrollments": { -"description": "Optional. The enrollment state of each alert.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment" -}, -"type": "array" -}, -"alertPolicy": { -"description": "Immutable. The fully qualified resource name of the AlertPolicy.", +"description": { +"description": "Optional. Description of the program.", "type": "string" }, -"contactDetails": { -"description": "Optional. The contact details for each alert policy.", +"files": { +"description": "Required. A list of source files that make up the overall program.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaContactDetails" +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile" }, "type": "array" +} }, -"languageCode": { -"description": "Optional. The language code used for notifications", -"type": "string" +"type": "object" }, -"regionCode": { -"description": "Optional. The region code used of the user that subscribed to the alert policy.", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation": { +"description": "Evaluation results for a program candidate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"properties": { +"insights": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"description": "Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt." +}, +"scores": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"description": "Optional. Contains the evaluation scores for the target metrics to optimize." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment": { -"description": "The alert enrollment status.", -"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyResourceConfigAlertEnrollment", +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission": { +"description": "Evaluation submission for a program candidate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission", "properties": { -"alertId": { -"description": "Immutable. The id of an alert.", -"type": "string" +"evaluation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"description": "Required. Evaluation results for the program candidate." }, -"enrollState": { -"description": "Required. The enrollment status of a customer.", -"enum": [ -"ENROLL_STATE_UNSPECIFIED", -"ENROLLED", -"DECLINED" -], -"enumDescriptions": [ -"Default value. Used for customers who have not responded to the alert policy.", -"Customer is enrolled in this policy.", -"Customer declined this policy." -], +"lockToken": { +"description": "Required. Lock token for the program obtained in the AcquireAlphaEvolvePrograms call.", "type": "string" }, -"notificationParams": { -"additionalProperties": { +"program": { +"description": "Required. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", "type": "string" -}, -"description": "Optional. Parameters used to instantiate a notification. Used for notifications that are triggered when registered. Not stored. * Gemini Business welcome emails. * Gemini Business user invitation emails.", -"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { -"description": "AlloyDB source import data from.", -"id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile": { +"description": "A single source file with its path, content and metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile", "properties": { -"clusterId": { -"description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", -"type": "string" -}, -"databaseId": { -"description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", -"type": "string" -}, -"gcsStagingDir": { -"description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", +"content": { +"description": "Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.", "type": "string" }, -"locationId": { -"description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", +"description": { +"description": "Optional. Additional description of the file.", "type": "string" }, -"projectId": { -"description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", +"path": { +"description": "Required. The relative path of the file, including the filename. e.g., \"src/main.py\", \"utils/helpers.js\", \"README.md\"", "type": "string" }, -"tableId": { -"description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", +"programLanguage": { +"description": "Optional. The programming language of the file.", "type": "string" } }, @@ -22115,7 +22948,7 @@ "type": "integer" }, "queryFrequencyThreshold": { -"description": "This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 8 used in the generation pipeline.", +"description": "This field is only meaningful for suggestions generated from user events or search history. If a query shows up less than this threshold, it may indicate that the query is rarely searched and thus will not be generated as a suggestion. This is field can be helpful for preventing PII queries becoming suggestions, as those queries are usually uniquely searched. If not set, the default value is 3 used in the generation pipeline.", "format": "int32", "type": "integer" }, @@ -23345,6 +24178,14 @@ "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -24185,6 +25026,11 @@ "description": "The number of end users under the user store that were successfully deleted.", "format": "int64", "type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" @@ -24737,7 +25583,8 @@ "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -24812,7 +25659,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -25203,7 +26050,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -25494,6 +26341,24 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest": { +"description": "Request message for UserLicenseService.ExportUserLicenses.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserLicensesRequest", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse": { +"description": "Response message for UserLicenseService.ExportUserLicenses.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserLicensesResponse", +"properties": { +"csvData": { +"description": "The full CSV document as raw bytes: the header row followed by one row per UserLicense. Contains user license data (e.g. user emails). An export with no matching licenses contains only the header row.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExternalIdentity": { "description": "External identity representing either a user or group. This user or group is from an external identity provider (IdP).", "id": "GoogleCloudDiscoveryengineV1alphaExternalIdentity", @@ -27216,6 +28081,46 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse": { +"description": "Response message for AlphaEvolveService.ListAlphaEvolveExperiments.", +"id": "GoogleCloudDiscoveryengineV1alphaListAlphaEvolveExperimentsResponse", +"properties": { +"alphaEvolveExperiments": { +"description": "Output only. List of experiments.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse": { +"description": "Response message for AlphaEvolveService.ListAlphaEvolvePrograms.", +"id": "GoogleCloudDiscoveryengineV1alphaListAlphaEvolveProgramsResponse", +"properties": { +"alphaEvolvePrograms": { +"description": "Output only. List of programs matching the criteria provided in the request.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram" +}, +"readOnly": true, +"type": "array" +}, +"nextPageToken": { +"description": "Output only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse": { "description": "Response message for the AssistantService.ListAssistants method.", "id": "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse", @@ -29575,6 +30480,31 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.ResumeExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest": { +"description": "Request message for AlphaEvolveService.ResumeExperiment.", +"id": "GoogleCloudDiscoveryengineV1alphaResumeExperimentRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest": { "description": "Request message for LicenseConfigService.RetractLicenseConfig method.", "id": "GoogleCloudDiscoveryengineV1alphaRetractLicenseConfigRequest", @@ -32237,6 +33167,36 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.StartExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStartExperimentRequest": { +"description": "Request message for AlphaEvolveService.StartExperiment.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest", +"properties": { +"name": { +"description": "Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest": { "description": "Request for the AssistantService.StreamAssist method.", "id": "GoogleCloudDiscoveryengineV1alphaStreamAssistRequest", @@ -32430,6 +33390,26 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest": { +"description": "Request message for AlphaEvolveService.SubmitProgramsEvaluations.", +"id": "GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsRequest", +"properties": { +"evaluationSubmissions": { +"description": "Required. List of program evaluations to submit. At this time, only one evaluation submission is supported.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluationSubmission" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse": { +"description": "Response message for AlphaEvolveService.SubmitProgramsEvaluations.", +"id": "GoogleCloudDiscoveryengineV1alphaSubmitProgramsEvaluationsResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", @@ -33629,7 +34609,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -33640,7 +34621,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "readOnly": true, "type": "string" @@ -33898,7 +34880,7 @@ false ], "type": "string" }, -"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "readOnly": true, "type": "object" }, @@ -33906,6 +34888,11 @@ false "$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsGenerativeAnswerConfig", "description": "Describes generative answer configuration." }, +"googleDrivePickerEnabled": { +"description": "Output only. Whether the Google Drive file picker is available to end-users. Declared `optional` for the same field-presence reason as `onedrive_picker_enabled` above.", +"readOnly": true, +"type": "boolean" +}, "interactionType": { "description": "Describes widget (or web app) interaction type", "enum": [ @@ -33945,6 +34932,11 @@ false "readOnly": true, "type": "object" }, +"onedrivePickerEnabled": { +"description": "Output only. Whether the OneDrive file picker is available to end-users. Computed by the backend from admin connector enablement (Business edition) or attached OneDrive connectors (Enterprise edition), combined with the existing `disable-onedrive-upload` admin feature. Declared `optional` so an explicitly-computed `false` is serialized with field presence. A plain proto3 `bool` drops a default `false` on the wire, which prevented clients from distinguishing \"picker disabled\" (`false`) from \"field not populated\" (unset).", +"readOnly": true, +"type": "boolean" +}, "resultDescriptionType": { "description": "Controls whether result extract is display and how (snippet or extractive answer). Default to no result if unspecified.", "enum": [ @@ -34051,6 +35043,11 @@ false "description": "A single model that is resolved to be available to the end-user in the model selector, with all of its localized display metadata.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModel", "properties": { +"adminView": { +"$ref": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView", +"description": "Output only. Admin-surface metadata; populated only for the Console admin Feature Control page (see `AdminView`). Unset for end-user surfaces.", +"readOnly": true +}, "description": { "description": "Output only. Localized description text (e.g. `State-of-the-art reasoning`). Localized using the same locale as `display_name`.", "readOnly": true, @@ -34079,6 +35076,31 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView": { +"description": "Admin-surface metadata. Populated only when the request originates from the Cloud Console admin \"Feature Control\" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.", +"id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsModelConfigInfoResolvedModelAdminView", +"properties": { +"adminOverridable": { +"description": "Output only. Whether the admin can toggle this model's enabled/disabled state via `UiSettings.model_configs`. Derived from `MODEL_TAG_ADMIN_OVERRIDABLE`. When false, the model is \"forced\" and its state is governed by `enabled_by_default`.", +"readOnly": true, +"type": "boolean" +}, +"enabledByDefault": { +"description": "Output only. Whether the model is enabled when the admin has set no explicit override in `UiSettings.model_configs`. Derived from `MODEL_TAG_ENABLED_BY_DEFAULT`.", +"readOnly": true, +"type": "boolean" +}, +"regions": { +"description": "Output only. Regions where this model is launched.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec": { "description": "SearchAddonSpec is used to disable add-ons for search. By default, if this field is not specified, add-ons are enabled wherever applicable.", "id": "GoogleCloudDiscoveryengineV1alphaWidgetConfigUiSettingsSearchAddonSpec", @@ -34126,7 +35148,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -34137,7 +35160,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -35437,7 +36461,8 @@ false "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -35512,7 +36537,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -35838,7 +36863,7 @@ false "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -38559,7 +39584,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -38570,7 +39596,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index b11d0932bc..28009ab7e9 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -9524,7 +9524,7 @@ } } }, -"revision": "20260620", +"revision": "20260706", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11240,6 +11240,14 @@ "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -12254,7 +12262,8 @@ "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -12329,7 +12338,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -12655,7 +12664,7 @@ "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -14414,7 +14423,8 @@ "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -14425,7 +14435,8 @@ "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -14667,6 +14678,385 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights": { +"description": "Evaluation insights for a program.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"properties": { +"insights": { +"description": "Optional. List of evaluation insights.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight": { +"description": "A single evaluation insight.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsightsAlphaEvolveEvaluationInsight", +"properties": { +"label": { +"description": "Optional. Label of the insight.", +"type": "string" +}, +"text": { +"description": "Optional. Text of the insight.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores": { +"description": "Contains the evaluation scores for the target metrics to optimize.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"properties": { +"scores": { +"description": "Required. List of evaluation scores.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore": { +"description": "Score for a single metric.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScoresAlphaEvolveEvaluationScore", +"properties": { +"metric": { +"description": "Required. Name of the metric.", +"type": "string" +}, +"score": { +"description": "Required. Score of a program for this metric.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment": { +"description": "An experiment is a single run of the AlphaEvolve agent, an evolutionary coding agent powered by LLM for algorithm discovery and optimization.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperiment", +"properties": { +"config": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"description": "Required. Experiment configuration." +}, +"createTime": { +"description": "Output only. Time when the experiment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"initialAlphaEvolveProgram": { +"description": "Output only. Specifies the name of the seed program used to start the experiment.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Identifier. The full resource name of the experiment. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the experiment.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATED", +"RUNNING", +"PAUSED", +"COMPLETED", +"FAILED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The experiment is created.", +"The experiment is running.", +"The experiment is paused.", +"The experiment is completed.", +"The experiment has failed." +], +"readOnly": true, +"type": "string" +}, +"stats": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", +"description": "Output only. Experiment stats.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig": { +"description": "Configuration of an experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfig", +"properties": { +"evolutionSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"description": "Optional. Evolution settings for the experiment." +}, +"generationSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"description": "Optional. Generation settings for the experiment, controlling how new program candidates are generated, including things LLM parameters and user-provided context and prompts." +}, +"problemDescription": { +"description": "Required. Description of the problem to be solved by the experiment.", +"type": "string" +}, +"programLanguage": { +"description": "Required. Primary programming language of the code being optimized.", +"type": "string" +}, +"runSettings": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"description": "Required. Run settings for the experiment, controlling the overall behavior of the experiment run." +}, +"title": { +"description": "Required. Title of the experiment.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings": { +"description": "Evolution settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettings", +"properties": { +"parentSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"description": "Optional. Parent sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig": { +"description": "Configuration for parent sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfig", +"properties": { +"paretoSamplingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"description": "Optional. Pareto sampling configuration." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig": { +"description": "Configuration for Pareto sampling.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigEvolutionSettingsParentSamplingConfigParetoSamplingConfig", +"properties": { +"paretoSamplingProbability": { +"description": "Optional. Probability [0.0, 1.0] of sampling parent programs from the Pareto frontier instead of normal fitness-based sampling during candidate generation. Useful when optimizing multiple metrics simultaneously. Default 0.0 (disabled). Only effective when evaluation returns multiple metrics in scores_to_optimize.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings": { +"description": "Generation settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettings", +"properties": { +"context": { +"description": "Optional. Additional user-provided context to be used during generation.", +"type": "string" +}, +"includeFullProgramInPrompt": { +"description": "Optional. When true, the LLM prompt includes the full program text (both mutable EVOLVE-BLOCK regions and immutable boilerplate). When false (default), only the mutable EVOLVE-BLOCK regions are shown, saving context window.", +"type": "boolean" +}, +"models": { +"description": "Optional. Per-model configuration. See `ModelConfig` for details. If left unset, the server selects a default model.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig": { +"description": "Per-model configuration. Mutually exclusive with `model_mixture` and `model`: when `models` is set, both `model_mixture` and `model` must be left unset. The same allowed-model list and at-most-2-models rule as for `model_mixture` apply. In addition, each entry may specify a per-model `temperature` for LLM sampling. Unlike `model_mixture`, weights here are *relative*: only their ratios matter (the server normalizes them), so callers may use any positive numbers without having to ensure they sum to 1.0.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigGenerationSettingsModelConfig", +"properties": { +"name": { +"description": "Required. Model name (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). See `model_mixture` for the list of allowed models.", +"type": "string" +}, +"weight": { +"description": "Optional. Relative weight for this model in the mixture. Must be a finite, strictly positive value. Weights across all entries are normalized server-side, so they need not sum to 1.0. Defaults to 1.0 when unset, which is convenient when configuring a single model or an even mixture. Some Pro-tier models are capped at most 50% of the total weight; requests violating that cap are rejected with INVALID_ARGUMENT.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings": { +"description": "Run settings for the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentConfigRunSettings", +"properties": { +"concurrency": { +"description": "Required. Maximum number of programs that can be generated in parallel. Must be positive.", +"format": "int32", +"type": "integer" +}, +"maxDuration": { +"description": "Optional. Maximum duration of the experiment. If unset, defaults to 24 hours.", +"format": "google-duration", +"type": "string" +}, +"maxPrograms": { +"description": "Required. Maximum number of programs to generate during the experiment run. The initial program counts towards this limit. Must be greater than 1.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats": { +"description": "Stats about the experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveExperimentStats", +"properties": { +"candidatesCount": { +"description": "Output only. Number of candidates generated.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"evaluatedCandidatesCount": { +"description": "Output only. Number of candidates evaluated.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"inputTokenCount": { +"description": "Output only. Number of billed input tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"outputTokenCount": { +"description": "Output only. Number of billed output tokens consumed by the experiment.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram": { +"description": "Represents a single program to be used within the context of an AlphaEvolve experiment.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgram", +"properties": { +"content": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", +"description": "Optional. Content of the program." +}, +"createTime": { +"description": "Output only. Time when the program was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"evaluation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"description": "Optional. Evaluation results for the program." +}, +"lockToken": { +"description": "Optional. Lock token for the program.", +"type": "string" +}, +"name": { +"description": "Identifier. Unique identifier for the program. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"type": "string" +}, +"parentPrograms": { +"description": "Output only. Optionally specifies which parent programs this program was evolved from. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}/alphaEvolvePrograms/{alpha_evolve_program}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. State of the program.", +"enum": [ +"PROGRAM_STATE_UNSPECIFIED", +"INITIALIZED", +"GENERATING", +"EVALUATING", +"COMPLETED" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"The program is initialized.", +"The program is in generation.", +"The program is pending evaluation.", +"The program is completed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent": { +"description": "A self-contained message containing the content of a program. Can represent a collection of files.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramContent", +"properties": { +"description": { +"description": "Optional. Description of the program.", +"type": "string" +}, +"files": { +"description": "Required. A list of source files that make up the overall program.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation": { +"description": "Evaluation results for a program candidate.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveProgramEvaluation", +"properties": { +"insights": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationInsights", +"description": "Optional. Represents various insights about the candidate, which are not directly used as optimization target, but that can be used to improve subsequent generations, and as such can be used to construct the evolution prompt." +}, +"scores": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveEvaluationScores", +"description": "Optional. Contains the evaluation scores for the target metrics to optimize." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile": { +"description": "A single source file with its path, content and metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAlphaEvolveSourceFile", +"properties": { +"content": { +"description": "Required. The raw content of the file. This is a string and not bytes, because it should be ultimately processed by the LLM as text.", +"type": "string" +}, +"description": { +"description": "Optional. Additional description of the file.", +"type": "string" +}, +"path": { +"description": "Required. The relative path of the file, including the filename. e.g., \"src/main.py\", \"utils/helpers.js\", \"README.md\"", +"type": "string" +}, +"programLanguage": { +"description": "Optional. The programming language of the file.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaAnswer": { "description": "Defines an answer.", "id": "GoogleCloudDiscoveryengineV1alphaAnswer", @@ -16923,6 +17313,14 @@ "$ref": "GoogleTypeDateTime", "description": "Defines the scheduled time for the next data synchronization. This field requires hour , minute, and time_zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). This is utilized when the data connector has a refresh interval greater than 1 day. When the hours or minutes are not specified, we will assume a sync time of 0:00. The user must provide a time zone to avoid ambiguity." }, +"oauthStaticIpAddresses": { +"description": "Output only. The static IP addresses used by this connector for OAuth APIs (e.g. end user authentication). These are surfaced separately from `static_ip_addresses` so that customers can apply granular firewall settings for OAuth endpoints. Only populated for connectors that have static IP enabled and are used for actions and/or federated search.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "params": { "additionalProperties": { "description": "Properties of the object.", @@ -17763,6 +18161,11 @@ "description": "The number of end users under the user store that were successfully deleted.", "format": "int64", "type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" @@ -18051,7 +18454,8 @@ "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -18126,7 +18530,7 @@ ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -18517,7 +18921,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -20518,6 +20922,25 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.ResumeExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaResumeExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudDiscoveryengineV1alphaSafetyRating", @@ -21877,6 +22300,36 @@ false }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata": { +"description": "Metadata for AlphaEvolveService.StartExperiment long running operation.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time the operation was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaStartExperimentRequest": { +"description": "Request message for AlphaEvolveService.StartExperiment.", +"id": "GoogleCloudDiscoveryengineV1alphaStartExperimentRequest", +"properties": { +"name": { +"description": "Required. Experiment to start. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/alphaEvolveExperiments/{alpha_evolve_experiment}`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaTargetSite": { "description": "A target site for the SiteSearchEngine.", "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", @@ -22278,7 +22731,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -22289,7 +22743,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } @@ -27157,7 +27612,8 @@ false "type": "string" }, "associatedAgentRegistry": { -"description": "Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting.", +"description": "Output only. The Agent registry containing the agents, MCP servers and tools associated with this engine. Derived server-side from the linked Agent Gateway's registry.", +"readOnly": true, "type": "string" }, "chatEngineConfig": { @@ -27232,7 +27688,7 @@ false ], "type": "string" }, -"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", +"description": "Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `deep-research`", "type": "object" }, "industryVertical": { @@ -27558,7 +28014,7 @@ false "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "properties": { "requiredSubscriptionTier": { -"description": "Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.", +"description": "Optional. The required subscription tier of this engine. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT.", "enum": [ "SUBSCRIPTION_TIER_UNSPECIFIED", "SUBSCRIPTION_TIER_SEARCH", @@ -33648,7 +34104,8 @@ false "GOOGLE_CHAT", "GOOGLE_GROUPS", "GOOGLE_KEEP", -"GOOGLE_PEOPLE" +"GOOGLE_PEOPLE", +"GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Defaults to an unspecified Workspace type.", @@ -33659,7 +34116,8 @@ false "Workspace Data Store contains Chat data", "Workspace Data Store contains Groups data", "Workspace Data Store contains Keep data", -"Workspace Data Store contains People data" +"Workspace Data Store contains People data", +"Workspace Data Store contains all Workspace apps data" ], "type": "string" } From 243fba7447cbb9a82ad7f51e9489e1ef2475ae3f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:56 +0000 Subject: [PATCH 31/50] feat(displayvideo): update the api #### displayvideo:v3 The following keys were deleted: - resources.firstAndThirdPartyAudiences.methods.create (Total Keys: 11) - resources.firstAndThirdPartyAudiences.methods.editCustomerMatchMembers (Total Keys: 13) - resources.firstAndThirdPartyAudiences.methods.get (Total Keys: 18) - resources.firstAndThirdPartyAudiences.methods.list (Total Keys: 22) - resources.firstAndThirdPartyAudiences.methods.patch (Total Keys: 19) - schemas.Consent (Total Keys: 4) - schemas.ContactInfo (Total Keys: 14) - schemas.EditCustomerMatchMembersRequest (Total Keys: 8) - schemas.EditCustomerMatchMembersResponse (Total Keys: 4) - schemas.FirstAndThirdPartyAudience (Total Keys: 38) - schemas.ListFirstAndThirdPartyAudiencesResponse (Total Keys: 5) - schemas.MobileDeviceIdList (Total Keys: 5) #### displayvideo:v4 The following keys were deleted: - schemas.EffectiveFrequencyBreakdown (Total Keys: 12) - schemas.GenerateReachForecastRequest.properties.effectiveFrequencyBreakdownLimit (Total Keys: 2) - schemas.PlannableTargeting.properties.network (Total Keys: 3) - schemas.PlannedProductForecast.properties.effectiveFrequencyBreakdowns (Total Keys: 2) The following keys were added: - schemas.AdvancedProductTargeting.properties.network.type (Total Keys: 1) - schemas.PlannableLocation.properties.parentPlannableLocationId (Total Keys: 3) - schemas.PlannableProductCoreAttributes (Total Keys: 8) - schemas.PlannableTargeting.properties.defaultYoutubeSelectLineup (Total Keys: 2) - schemas.PlannableTargeting.properties.network (Total Keys: 2) - schemas.ProductMetadata.properties.plannableProductCoreAttributes (Total Keys: 2) - schemas.SurfaceTargetingCombinations.properties.defaultSurfaceTypes (Total Keys: 3) --- ...displayvideo_v2.advertisers.lineItems.html | 56 +- ...yvideo_v2.advertisers.youtubeAdGroups.html | 4 +- ...isplayvideo_v3.advertisers.adGroupAds.html | 168 +++--- .../displayvideo_v3.advertisers.adGroups.html | 28 +- ...rgetingTypes.assignedTargetingOptions.html | 8 +- ...displayvideo_v3.advertisers.lineItems.html | 70 +-- docs/dyn/displayvideo_v3.html | 5 - ...isplayvideo_v4.advertisers.adGroupAds.html | 168 +++--- .../displayvideo_v4.advertisers.adGroups.html | 28 +- ...rgetingTypes.assignedTargetingOptions.html | 8 +- ...displayvideo_v4.advertisers.lineItems.html | 70 +-- ...layvideo_v4.advertisers.reachForecast.html | 41 +- ...ideo_v4.firstPartyAndPartnerAudiences.html | 132 ++-- .../documents/displayvideo.v2.json | 12 +- .../documents/displayvideo.v3.json | 571 +----------------- .../documents/displayvideo.v4.json | 259 +++++--- 16 files changed, 588 insertions(+), 1040 deletions(-) diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html index 15582c2009..67c3c4814c 100644 --- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html @@ -850,16 +850,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -946,7 +946,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1121,16 +1121,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1217,7 +1217,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1352,16 +1352,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1448,7 +1448,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1638,16 +1638,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1734,7 +1734,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -1882,16 +1882,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1978,7 +1978,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2133,16 +2133,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2229,7 +2229,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -2365,16 +2365,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2461,7 +2461,7 @@

Method Details

}, "reservationType": "A String", # Output only. The reservation type of the line item. "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, diff --git a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html index b549aa3a17..1553846c62 100644 --- a/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html +++ b/docs/dyn/displayvideo_v2.advertisers.youtubeAdGroups.html @@ -478,7 +478,7 @@

Method Details

"productMatchType": "A String", # How products are selected by the product feed. }, "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, @@ -537,7 +537,7 @@

Method Details

"productMatchType": "A String", # How products are selected by the product feed. }, "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [targeting expansion](https://support.google.com/displayvideo/answer/10191558) settings of the ad group. This config is only applicable when eligible audience list targeting is assigned to the ad group. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. "excludeFirstPartyAudience": True or False, # Whether to exclude first-party audiences from use in targeting expansion. This field was deprecated with the launch of [optimized targeting](//support.google.com/displayvideo/answer/12060859). This field will be set to `false`. If this field is set to `true` when deprecated, all positive first-party audience targeting assigned to this line item will be replaced with negative targeting of the same first-party audiences to ensure the continued exclusion of those audiences. "targetingExpansionLevel": "A String", # Required. Whether optimized targeting is turned on. This field supports the following values: * `NO_EXPANSION`: optimized targeting is turned off * `LEAST_EXPANSION`: optimized targeting is turned on If this field is set to any other value, it will automatically be set to `LEAST_EXPANSION`. `NO_EXPANSION` will be the default value for the field and will be automatically assigned if you do not set the field. }, diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html index 68ae683673..777833e9f1 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroupAds.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Creates an ad group ad. This method is only supported for Demand Gen ads.

delete(advertiserId, adGroupAdId, x__xgafv=None)

-

Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes an ad group ad. This method is only supported for Demand Gen ads.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

-

Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Updates an ad group ad. This method is only supported for Demand Gen ads.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Creates an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -286,13 +286,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -335,7 +335,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -347,8 +347,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -362,7 +362,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -409,8 +409,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -421,7 +421,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -433,8 +433,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -459,7 +459,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -799,13 +799,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -848,7 +848,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -860,8 +860,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -875,7 +875,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -922,8 +922,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -934,7 +934,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -946,8 +946,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -972,7 +972,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1131,7 +1131,7 @@

Method Details

delete(advertiserId, adGroupAdId, x__xgafv=None) -
Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
@@ -1339,13 +1339,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1388,7 +1388,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1400,8 +1400,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1415,7 +1415,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1462,8 +1462,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1474,7 +1474,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1486,8 +1486,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1512,7 +1512,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1865,13 +1865,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1914,7 +1914,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1926,8 +1926,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1941,7 +1941,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1988,8 +1988,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2000,7 +2000,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2012,8 +2012,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2038,7 +2038,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2214,7 +2214,7 @@

Method Details

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) -
Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Updates an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -2398,13 +2398,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2447,7 +2447,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2459,8 +2459,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2474,7 +2474,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -2521,8 +2521,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2533,7 +2533,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2545,8 +2545,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2571,7 +2571,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2912,13 +2912,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2961,7 +2961,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2973,8 +2973,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2988,7 +2988,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -3035,8 +3035,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -3047,7 +3047,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -3059,8 +3059,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3085,7 +3085,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html index 27074e7deb..312d7903e4 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html @@ -81,7 +81,7 @@

Instance Methods

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

-

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.

bulkListAdGroupAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -93,10 +93,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.

delete(advertiserId, adGroupId, x__xgafv=None)

-

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -108,11 +108,11 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.

Method Details

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) -
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
@@ -883,7 +883,7 @@ 

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -955,7 +955,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, } @@ -1032,14 +1032,14 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
delete(advertiserId, adGroupId, x__xgafv=None) -
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
@@ -1136,7 +1136,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
@@ -1226,7 +1226,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }, ], @@ -1250,7 +1250,7 @@

Method Details

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -1323,7 +1323,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, } @@ -1401,7 +1401,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index b3df0657ad..207c50e63a 100644 --- a/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

-

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

-

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -100,7 +100,7 @@

Method Details

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) -
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -838,7 +838,7 @@ 

Method Details

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) -
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
index be373d4e23..61459cd376 100644
--- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
@@ -942,16 +942,16 @@ 

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1041,7 +1041,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1066,7 +1066,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1213,16 +1213,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1312,7 +1312,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1337,7 +1337,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1444,16 +1444,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1543,7 +1543,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1568,7 +1568,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1730,16 +1730,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1829,7 +1829,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1854,7 +1854,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1974,16 +1974,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2073,7 +2073,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2098,7 +2098,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2225,16 +2225,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2324,7 +2324,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2349,7 +2349,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2457,16 +2457,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2556,7 +2556,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2581,7 +2581,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v3.html b/docs/dyn/displayvideo_v3.html index 52ef8513e3..1707148b23 100644 --- a/docs/dyn/displayvideo_v3.html +++ b/docs/dyn/displayvideo_v3.html @@ -94,11 +94,6 @@

Instance Methods

Returns the customLists Resource.

-

- firstAndThirdPartyAudiences() -

-

Returns the firstAndThirdPartyAudiences Resource.

-

floodlightGroups()

diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html index cd69a48a46..26da9e185a 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroupAds.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Creates an ad group ad. This method is only supported for Demand Gen ads.

delete(advertiserId, adGroupAdId, x__xgafv=None)

-

Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes an ad group ad. This method is only supported for Demand Gen ads.

get(advertiserId, adGroupAdId, x__xgafv=None)

Gets an ad group ad.

@@ -94,7 +94,7 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None)

-

Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Updates an ad group ad. This method is only supported for Demand Gen ads.

Method Details

close() @@ -103,7 +103,7 @@

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Creates an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -286,13 +286,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -335,7 +335,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -347,8 +347,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -362,7 +362,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -409,8 +409,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -421,7 +421,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -433,8 +433,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -459,7 +459,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -799,13 +799,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -848,7 +848,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -860,8 +860,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -875,7 +875,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -922,8 +922,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -934,7 +934,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -946,8 +946,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -972,7 +972,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1131,7 +1131,7 @@

Method Details

delete(advertiserId, adGroupAdId, x__xgafv=None) -
Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad belongs to. (required)
@@ -1339,13 +1339,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1388,7 +1388,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1400,8 +1400,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1415,7 +1415,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1462,8 +1462,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1474,7 +1474,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1486,8 +1486,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -1512,7 +1512,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1865,13 +1865,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -1914,7 +1914,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -1926,8 +1926,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -1941,7 +1941,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -1988,8 +1988,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2000,7 +2000,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2012,8 +2012,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2038,7 +2038,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2214,7 +2214,7 @@

Method Details

patch(advertiserId, adGroupAdId, body=None, updateMask=None, x__xgafv=None) -
Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Updates an ad group ad. This method is only supported for Demand Gen ads.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad belongs to. (required)
@@ -2398,13 +2398,13 @@ 

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2447,7 +2447,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2459,8 +2459,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2474,7 +2474,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -2521,8 +2521,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2533,7 +2533,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2545,8 +2545,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -2571,7 +2571,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2912,13 +2912,13 @@

Method Details

}, }, }, - "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "dcmTrackingInfo": { # Details on the DCM tracking. # Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. "creativeId": "A String", # Required. The DCM creative id. "placementId": "A String", # Required. The DCM placement id. "trackingAdId": "A String", # Required. The DCM tracking ad id. }, - "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenCarouselAd": { # Details for a Demand Gen carousel ad. # Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "cards": [ # Required. The list of cards shown on the ad. { # Details for a Demand Gen carousel card. "callToAction": "A String", # Required. The text on the call-to-action button shown on the card. Must use 10 characters or less. @@ -2961,7 +2961,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -2973,8 +2973,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenImageAd": { # Details for a Demand Gen image ad. # Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -2988,7 +2988,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logoImages": [ # The list of logo images shown on the ad. + "logoImages": [ # The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. { # Meta data of an image asset. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. @@ -3035,8 +3035,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenProductAd": { # Details for a Demand Gen product ad. # Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `APPLY_NOW` * `BOOK_NOW` * `CONTACT_US` * `DOWNLOAD` * `GET_QUOTE` * `LEARN_MORE` * `SHOP_NOW` * `SIGN_UP` * `SUBSCRIBE` "customParameters": { # Optional. The custom parameters and accompanying values to add to the tracking URL. "a_key": "A String", @@ -3047,7 +3047,7 @@

Method Details

"finalUrl": "A String", # Required. The URL address of the webpage that people reach after they click the ad. "finalUrlSuffix": "A String", # Optional. The suffix to append to landing page URLs. "headline": "A String", # Required. The headline of the ad. - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. @@ -3059,8 +3059,8 @@

Method Details

"trackingUrl": "A String", # Output only. The URL address loaded in the background for tracking purposes. "userSpecifiedTrackingUrl": "A String", # Optional. The tracking URL specified by the user manually. }, - "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. - "businessName": "A String", # Required. The business name shown on the ad. + "demandGenVideoAd": { # Details for a Demand Gen video ad. # Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). + "businessName": "A String", # Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "callToAction": "A String", # Required. The call-to-action button shown on the ad. The supported values are: * `AUTOMATED` * `LEARN_MORE` * `GET_QUOTE` * `APPLY_NOW` * `SIGN_UP` * `CONTACT_US` * `SUBSCRIBE` * `DOWNLOAD` * `BOOK_NOW` * `SHOP_NOW` * `BUY_NOW` * `DONATE_NOW` * `ORDER_NOW` * `PLAY_NOW` * `SEE_MORE` * `START_NOW` * `VISIT_SITE` * `WATCH_NOW` "companionBanner": { # Meta data of an image asset. # Optional. The companion banner used by this ad. "assetId": "A String", # Required. The unique ID of the asset. @@ -3085,7 +3085,7 @@

Method Details

"headlines": [ # Required. The list of headlines shown on the ad. "A String", ], - "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. + "logo": { # Meta data of an image asset. # Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied. "assetId": "A String", # Required. The unique ID of the asset. "fileSize": "A String", # Output only. File size of the image asset in bytes. "fullSize": { # Dimensions. # Output only. Metadata for this image at its original size. diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html index 291d0d6177..85f1b9173d 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html @@ -86,7 +86,7 @@

Instance Methods

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None)

-

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.

bulkListAssignedTargetingOptions(advertiserId, adGroupIds=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.

@@ -98,10 +98,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, body=None, x__xgafv=None)

-

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.

delete(advertiserId, adGroupId, x__xgafv=None)

-

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.

get(advertiserId, adGroupId, x__xgafv=None)

Gets an ad group.

@@ -113,11 +113,11 @@

Instance Methods

Retrieves the next page of results.

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None)

-

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.

Method Details

bulkEditAssignedTargetingOptions(advertiserId, body=None, x__xgafv=None) -
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad groups belong to. (required)
@@ -888,7 +888,7 @@ 

Method Details

create(advertiserId, body=None, x__xgafv=None) -
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -960,7 +960,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, } @@ -1037,14 +1037,14 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
delete(advertiserId, adGroupId, x__xgafv=None) -
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser this ad group belongs to. (required)
@@ -1141,7 +1141,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
@@ -1231,7 +1231,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }, ], @@ -1255,7 +1255,7 @@

Method Details

patch(advertiserId, adGroupId, body=None, updateMask=None, x__xgafv=None) -
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Output only. The unique ID of the advertiser the ad group belongs to. (required)
@@ -1328,7 +1328,7 @@ 

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, } @@ -1406,7 +1406,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, }
diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html index 6ee2498a20..07fd4a3ed2 100644 --- a/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html +++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.targetingTypes.assignedTargetingOptions.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None)

-

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

-

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.

+

Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.

get(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None)

Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.

@@ -100,7 +100,7 @@

Method Details

create(advertiserId, adGroupId, targetingType, body=None, x__xgafv=None) -
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
@@ -838,7 +838,7 @@ 

Method Details

delete(advertiserId, adGroupId, targetingType, assignedTargetingOptionId, x__xgafv=None) -
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.
+  
Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.
 
 Args:
   advertiserId: string, Required. The ID of the advertiser the ad group belongs to. (required)
diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html
index 2090a715e9..fa29f83e23 100644
--- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html
@@ -947,16 +947,16 @@ 

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1046,7 +1046,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1071,7 +1071,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1218,16 +1218,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1317,7 +1317,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1342,7 +1342,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1449,16 +1449,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1548,7 +1548,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1573,7 +1573,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1735,16 +1735,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1834,7 +1834,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1859,7 +1859,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -1979,16 +1979,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2078,7 +2078,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2103,7 +2103,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2230,16 +2230,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2329,7 +2329,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2354,7 +2354,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2462,16 +2462,16 @@

Method Details

}, ], "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000. - "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "primaryAttributionModelId": "A String", # Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. }, "creativeIds": [ # The IDs of the creatives associated with the line item. "A String", ], - "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "demandGenSettings": { # Settings for Demand Gen line items. # Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. "geoLanguageTargetingEnabled": True or False, # Optional. Immutable. Whether location and language targeting can be set at the line item level. Otherwise, relevant targeting types must be assigned directly to ad groups. "linkedMerchantId": "A String", # Optional. The ID of the Merchant Center account used to provide a product feed. This Merchant Center account must already be linked to the advertiser. "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third party measurement settings for the Demand Gen line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. @@ -2561,7 +2561,7 @@

Method Details

"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. - "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*. + "excludeDemographicExpansion": True or False, # Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2586,7 +2586,7 @@

Method Details

"timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 }, "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item. - "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` + "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`. { # Settings that control how third-party measurement vendors are configured. "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item. "vendor": "A String", # The third-party measurement vendor. diff --git a/docs/dyn/displayvideo_v4.advertisers.reachForecast.html b/docs/dyn/displayvideo_v4.advertisers.reachForecast.html index 5aac49bad1..e9c4fbe9fd 100644 --- a/docs/dyn/displayvideo_v4.advertisers.reachForecast.html +++ b/docs/dyn/displayvideo_v4.advertisers.reachForecast.html @@ -127,8 +127,7 @@

Method Details

"durationDays": 42, # Required. The number of days the plan covers. }, "currencyCode": "A String", # Required. The currency code for the plan in ISO 4217 format. - "effectiveFrequencyBreakdownLimit": 42, # Optional. The highest minimum effective frequency to include in PlannedProductForecast.effective_frequency_breakdowns. Must be between 1 and 10, inclusive. If not specified, PlannedProductForecast.effective_frequency_breakdowns will not be populated. If set, this value will also be used as the minimum effective frequency for reach metrics reporting. This field cannot be combined with the min_effective_frequency field. - "minEffectiveFrequency": 42, # Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied. This field cannot be combined with effective_frequency_breakdown_limit. + "minEffectiveFrequency": 42, # Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied. "plannedProducts": [ # Required. The list of line items to include in the forecast. { # Configuration for a specific product in the plan. "advancedProductTargeting": { # Product-specific targeting overrides. # Optional. Optional line item level targeting overrides. @@ -158,6 +157,7 @@

Method Details

"genders": [ # Optional. The gender options to target. "A String", ], + "network": "A String", # Optional. The network to target. "plannableLocationIds": [ # Optional. Plannable location IDs to target. "A String", ], @@ -217,15 +217,6 @@

Method Details

{ # A single point in the reach curve. "costMicros": "A String", # Total cost for this point in micros. "forecast": { # Performance metrics for a forecast point. # Aggregate forecast for the entire plan. - "effectiveFrequencyBreakdowns": [ # A list of effective frequency breakdowns. - { # A breakdown of the number of unique people reached at a given effective frequency. - "effectiveCoviewReach": "A String", # The number of unique individuals, including co-viewers, exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency. - "effectiveFrequency": 42, # The set effective frequency. - "onTargetEffectiveCoviewReach": "A String", # The total number of unique individuals, including co-viewers that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting. - "onTargetReach": "A String", # The number of unique individuals exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency. - "totalReach": "A String", # The total number of unique individuals that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting. - }, - ], "onTargetImpressions": "A String", # Number of on-target impressions. "onTargetReach": "A String", # Number of unique people reached that match the on-target definition. "totalImpressions": "A String", # Total number of impressions. @@ -238,15 +229,6 @@

Method Details

"costMicros": "A String", # The cost in micros for this product. "plannableProductCode": "A String", # The code for the product. "plannedProductForecast": { # Performance metrics for a forecast point. # Performance metrics for the product. - "effectiveFrequencyBreakdowns": [ # A list of effective frequency breakdowns. - { # A breakdown of the number of unique people reached at a given effective frequency. - "effectiveCoviewReach": "A String", # The number of unique individuals, including co-viewers, exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency. - "effectiveFrequency": 42, # The set effective frequency. - "onTargetEffectiveCoviewReach": "A String", # The total number of unique individuals, including co-viewers that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting. - "onTargetReach": "A String", # The number of unique individuals exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency. - "totalReach": "A String", # The total number of unique individuals that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting. - }, - ], "onTargetImpressions": "A String", # Number of on-target impressions. "onTargetReach": "A String", # Number of unique people reached that match the on-target definition. "totalImpressions": "A String", # Total number of impressions. @@ -282,6 +264,7 @@

Method Details

"displayName": "A String", # Output only. The display name of the location, for example "Algeria". "geoRegionType": "A String", # Output only. The type of location. "name": "A String", # Output only. The resource name of the plannable location. + "parentPlannableLocationId": "A String", # Output only. The parent plannable location ID, for example the country ID for subgeos. "plannableLocationId": "A String", # Output only. The plannable location ID. "regionCode": "A String", # Output only. The region code of the location, for example "DZ" for Algeria. }, @@ -309,24 +292,34 @@

Method Details

{ # Metadata for a plannable product. "displayName": "A String", # Output only. The name associated with the ad product. For example: "Video View Campaign". "plannableProductCode": "A String", # Output only. The plannable product code (e.g. "YOUTUBE_REACH_MIX"). + "plannableProductCoreAttributes": { # Core attributes for a plannable product. # Output only. Core attributes for this product. + "buyingMethod": "A String", # Output only. The buying method. + "costModel": "A String", # Output only. The cost model. + "productCategory": "A String", # Output only. The product category. + }, "plannableProductDescription": "A String", # Output only. The plain-text description of the ad product. "plannableTargeting": { # Targeting capabilities for a given product. # Output only. The targeting capabilities available for this product. "ageRanges": [ # Output only. Allowed plannable age ranges for the product. Actual targeting is computed by mapping this age range onto standard Google age targeting. "A String", ], + "defaultYoutubeSelectLineup": { # A Plannable YouTube Select Lineup for product targeting. # Output only. The default YouTube Select Lineup for this product, if applicable. + "displayName": "A String", # Output only. The display name of the YouTube Select Lineup. + "lineupId": "A String", # Output only. The ID of the YouTube Select Lineup. + }, "devices": [ # Output only. Targetable devices for the ad product. "A String", ], "genders": [ # Output only. Targetable genders for the ad product. "A String", ], - "networks": [ # Output only. Targetable networks for the ad product. - "A String", - ], + "network": "A String", # Output only. Targetable network for the ad product. "surfaceTargetingCombinations": { # Surface targeting rules. # Output only. Targetable surface combinations for the ad product. "availableSurfaceTypes": [ # Output only. The surface types available. "A String", ], + "defaultSurfaceTypes": [ # Output only. The default surface types for this product. + "A String", + ], "validSurfaceCombinations": [ # Output only. Valid combinations of surfaces that can be selected together. { # A valid combination of surfaces. "choices": [ # Output only. The combination of surfaces. @@ -387,7 +380,7 @@

Method Details

Args: advertiserId: string, Required. The ID of the advertiser to retrieve plannable user lists for. (required) - filter: string, Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` Examples: * All plannable user lists: `plannableStatus="PLANNABLE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + filter: string, Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` * `displayName` * `userListType` * `name` Examples: * All plannable user lists: `plannableStatus="PLANNABLE"` * Plannable user lists with display name containing "Shopping": `plannableStatus="PLANNABLE" AND displayName:"Shopping"` * First party user lists: `userListType="FIRST_PARTY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. pageSize: integer, Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `5000`. pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `RetrievePlannableUserLists` method. If not specified, the first page of results will be returned. x__xgafv: string, V1 error format. diff --git a/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html b/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html index 6eecd47072..52ff9c7bba 100644 --- a/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html +++ b/docs/dyn/displayvideo_v4.firstPartyAndPartnerAudiences.html @@ -119,18 +119,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -151,7 +151,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -178,18 +178,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -210,7 +210,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -228,24 +228,24 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. +{ # Request message for FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers. "addedContactInfoList": { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be added. "consent": { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error. "adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -256,7 +256,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -266,18 +266,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -288,7 +288,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -302,7 +302,7 @@

Method Details

Returns: An object of the form: - { # The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. + { # The response of FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers. "firstPartyAndPartnerAudienceId": "A String", # Required. The ID of the updated Customer Match FirstPartyAndPartnerAudience. }
@@ -333,18 +333,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -365,7 +365,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -405,18 +405,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -437,7 +437,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -482,18 +482,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -514,7 +514,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, @@ -542,18 +542,18 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "contactInfos": [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. + "contactInfos": [ # Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000. { # Contact information defining a Customer Match audience member. - "countryCode": "A String", # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes - "hashedEmails": [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + "countryCode": "A String", # Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes + "hashedEmails": [ # Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. "A String", ], - "hashedFirstName": "A String", # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes - "hashedLastName": "A String", # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes - "hashedPhoneNumbers": [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code. + "hashedFirstName": "A String", # Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes + "hashedLastName": "A String", # Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes + "hashedPhoneNumbers": [ # Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code. "A String", ], - "zipCodes": [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + "zipCodes": [ # Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name "A String", ], }, @@ -574,7 +574,7 @@

Method Details

"adPersonalization": "A String", # Represents consent for ad personalization. "adUserData": "A String", # Represents consent for ad user data. }, - "mobileDeviceIds": [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + "mobileDeviceIds": [ # Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. "A String", ], }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v2.json b/googleapiclient/discovery_cache/documents/displayvideo.v2.json index a9c27723d6..2df6dbc8fb 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v2.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v2.json @@ -7823,7 +7823,7 @@ } } }, -"revision": "20260617", +"revision": "20260630", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -10607,7 +10607,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", "format": "int64", "type": "string" } @@ -15063,7 +15063,7 @@ true }, "demandGenSettings": { "$ref": "DemandGenSettings", -"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items." }, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", @@ -15166,7 +15166,7 @@ true "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"Demand Gen ads." ], "type": "string" }, @@ -17985,7 +17985,7 @@ false "id": "TargetingExpansionConfig", "properties": { "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups.", "type": "boolean" }, "excludeFirstPartyAudience": { @@ -18290,7 +18290,7 @@ true "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", "items": { "$ref": "ThirdPartyVendorConfig" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index 1e999c89ce..236a6f1440 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -377,7 +377,7 @@ "adGroupAds": { "methods": { "create": { -"description": "Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Creates an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroupAds.create", @@ -406,7 +406,7 @@ ] }, "delete": { -"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroupAds.delete", @@ -523,7 +523,7 @@ ] }, "patch": { -"description": "Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Updates an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroupAds.patch", @@ -571,7 +571,7 @@ "adGroups": { "methods": { "bulkEditAssignedTargetingOptions": { -"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.", "flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", @@ -654,7 +654,7 @@ ] }, "create": { -"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v3/advertisers/{advertisersId}/adGroups", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.create", @@ -683,7 +683,7 @@ ] }, "delete": { -"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.delete", @@ -800,7 +800,7 @@ ] }, "patch": { -"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroups.patch", @@ -850,7 +850,7 @@ "assignedTargetingOptions": { "methods": { "create": { -"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", @@ -1002,7 +1002,7 @@ ] }, "delete": { -"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.", "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", @@ -5647,192 +5647,6 @@ } } }, -"firstAndThirdPartyAudiences": { -"methods": { -"create": { -"description": "Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", -"flatPath": "v3/firstAndThirdPartyAudiences", -"httpMethod": "POST", -"id": "displayvideo.firstAndThirdPartyAudiences.create", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/firstAndThirdPartyAudiences", -"request": { -"$ref": "FirstAndThirdPartyAudience" -}, -"response": { -"$ref": "FirstAndThirdPartyAudience" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"editCustomerMatchMembers": { -"description": "Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", -"flatPath": "v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}:editCustomerMatchMembers", -"httpMethod": "POST", -"id": "displayvideo.firstAndThirdPartyAudiences.editCustomerMatchMembers", -"parameterOrder": [ -"firstAndThirdPartyAudienceId" -], -"parameters": { -"firstAndThirdPartyAudienceId": { -"description": "Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers", -"request": { -"$ref": "EditCustomerMatchMembersRequest" -}, -"response": { -"$ref": "EditCustomerMatchMembersResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"get": { -"description": "Gets a first and third party audience.", -"flatPath": "v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}", -"httpMethod": "GET", -"id": "displayvideo.firstAndThirdPartyAudiences.get", -"parameterOrder": [ -"firstAndThirdPartyAudienceId" -], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that has access to the fetched first and third party audience.", -"format": "int64", -"location": "query", -"type": "string" -}, -"firstAndThirdPartyAudienceId": { -"description": "Required. The ID of the first and third party audience to fetch.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that has access to the fetched first and third party audience.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}", -"response": { -"$ref": "FirstAndThirdPartyAudience" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"list": { -"description": "Lists first and third party audiences. The order is defined by the order_by parameter.", -"flatPath": "v3/firstAndThirdPartyAudiences", -"httpMethod": "GET", -"id": "displayvideo.firstAndThirdPartyAudiences.list", -"parameterOrder": [], -"parameters": { -"advertiserId": { -"description": "The ID of the advertiser that has access to the fetched first and third party audiences.", -"format": "int64", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.", -"location": "query", -"type": "string" -}, -"partnerId": { -"description": "The ID of the partner that has access to the fetched first and third party audiences.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v3/firstAndThirdPartyAudiences", -"response": { -"$ref": "ListFirstAndThirdPartyAudiencesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -}, -"patch": { -"description": "Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", -"flatPath": "v3/firstAndThirdPartyAudiences/{firstAndThirdPartyAudiencesId}", -"httpMethod": "PATCH", -"id": "displayvideo.firstAndThirdPartyAudiences.patch", -"parameterOrder": [ -"firstAndThirdPartyAudienceId" -], -"parameters": { -"advertiserId": { -"description": "Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.", -"format": "int64", -"location": "query", -"type": "string" -}, -"firstAndThirdPartyAudienceId": { -"description": "Output only. The unique ID of the first and third party audience. Assigned by the system.", -"format": "int64", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}", -"request": { -"$ref": "FirstAndThirdPartyAudience" -}, -"response": { -"$ref": "FirstAndThirdPartyAudience" -}, -"scopes": [ -"https://www.googleapis.com/auth/display-video" -] -} -} -}, "floodlightGroups": { "methods": { "get": { @@ -8546,7 +8360,7 @@ } } }, -"revision": "20260617", +"revision": "20260630", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -8692,7 +8506,7 @@ "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"Demand Gen ads." ], "type": "string" }, @@ -8807,23 +8621,23 @@ }, "dcmTrackingInfo": { "$ref": "DcmTrackingInfo", -"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty." }, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", -"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." }, "demandGenImageAd": { "$ref": "DemandGenImageAd", -"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." }, "demandGenProductAd": { "$ref": "DemandGenProductAd", -"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." }, "demandGenVideoAd": { "$ref": "DemandGenVideoAd", -"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." }, "displayName": { "description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", @@ -12878,99 +12692,6 @@ }, "type": "object" }, -"Consent": { -"description": "User consent status.", -"id": "Consent", -"properties": { -"adPersonalization": { -"description": "Represents consent for ad personalization.", -"enum": [ -"CONSENT_STATUS_UNSPECIFIED", -"CONSENT_STATUS_GRANTED", -"CONSENT_STATUS_DENIED" -], -"enumDescriptions": [ -"Type value is not specified or is unknown in this version.", -"Consent is granted.", -"Consent is denied." -], -"type": "string" -}, -"adUserData": { -"description": "Represents consent for ad user data.", -"enum": [ -"CONSENT_STATUS_UNSPECIFIED", -"CONSENT_STATUS_GRANTED", -"CONSENT_STATUS_DENIED" -], -"enumDescriptions": [ -"Type value is not specified or is unknown in this version.", -"Consent is granted.", -"Consent is denied." -], -"type": "string" -} -}, -"type": "object" -}, -"ContactInfo": { -"description": "Contact information defining a Customer Match audience member.", -"id": "ContactInfo", -"properties": { -"countryCode": { -"description": "Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes", -"type": "string" -}, -"hashedEmails": { -"description": "A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.", -"items": { -"type": "string" -}, -"type": "array" -}, -"hashedFirstName": { -"description": "SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes", -"type": "string" -}, -"hashedLastName": { -"description": "SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes", -"type": "string" -}, -"hashedPhoneNumbers": { -"description": "A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.", -"items": { -"type": "string" -}, -"type": "array" -}, -"zipCodes": { -"description": "A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"ContactInfoList": { -"description": "Wrapper message for a list of contact information defining Customer Match audience members.", -"id": "ContactInfoList", -"properties": { -"consent": { -"$ref": "Consent", -"description": "Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." -}, -"contactInfos": { -"description": "A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.", -"items": { -"$ref": "ContactInfo" -}, -"type": "array" -} -}, -"type": "object" -}, "ContentDurationAssignedTargetingOptionDetails": { "description": "Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect.", "id": "ContentDurationAssignedTargetingOptionDetails", @@ -13380,7 +13101,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", "format": "int64", "type": "string" } @@ -14745,7 +14466,7 @@ false "id": "DemandGenCarouselAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "cards": { @@ -14780,7 +14501,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -14799,7 +14520,7 @@ false "id": "DemandGenImageAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -14840,7 +14561,7 @@ false "type": "array" }, "logoImages": { -"description": "The list of logo images shown on the ad.", +"description": "The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "items": { "$ref": "ImageAsset" }, @@ -14884,7 +14605,7 @@ false "id": "DemandGenProductAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -14966,7 +14687,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -15005,7 +14726,7 @@ false "id": "DemandGenVideoAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -15101,7 +14822,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "longHeadlines": { "description": "Required. The list of long headlines shown on the ad.", @@ -15692,46 +15413,6 @@ false }, "type": "object" }, -"EditCustomerMatchMembersRequest": { -"description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", -"id": "EditCustomerMatchMembersRequest", -"properties": { -"addedContactInfoList": { -"$ref": "ContactInfoList", -"description": "Input only. A list of contact information to define the members to be added." -}, -"addedMobileDeviceIdList": { -"$ref": "MobileDeviceIdList", -"description": "Input only. A list of mobile device IDs to define the members to be added." -}, -"advertiserId": { -"description": "Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.", -"format": "int64", -"type": "string" -}, -"removedContactInfoList": { -"$ref": "ContactInfoList", -"description": "Input only. A list of contact information to define the members to be removed." -}, -"removedMobileDeviceIdList": { -"$ref": "MobileDeviceIdList", -"description": "Input only. A list of mobile device IDs to define the members to be removed." -} -}, -"type": "object" -}, -"EditCustomerMatchMembersResponse": { -"description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", -"id": "EditCustomerMatchMembersResponse", -"properties": { -"firstAndThirdPartyAudienceId": { -"description": "Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "EditGuaranteedOrderReadAccessorsRequest": { "description": "Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors.", "id": "EditGuaranteedOrderReadAccessorsRequest", @@ -16694,165 +16375,6 @@ false }, "type": "object" }, -"FirstAndThirdPartyAudience": { -"description": "Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.", -"id": "FirstAndThirdPartyAudience", -"properties": { -"activeDisplayAudienceSize": { -"description": "Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"appId": { -"description": "The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`", -"type": "string" -}, -"audienceSource": { -"description": "Output only. The source of the audience.", -"enum": [ -"AUDIENCE_SOURCE_UNSPECIFIED", -"DISPLAY_VIDEO_360", -"CAMPAIGN_MANAGER", -"AD_MANAGER", -"SEARCH_ADS_360", -"YOUTUBE", -"ADS_DATA_HUB" -], -"enumDescriptions": [ -"Default value when audience source is not specified or is unknown.", -"Originated from Display & Video 360.", -"Originated from Campaign Manager 360.", -"Originated from Google Ad Manager.", -"Originated from Search Ads 360.", -"Originated from Youtube.", -"Originated from Ads Data Hub." -], -"readOnly": true, -"type": "string" -}, -"audienceType": { -"description": "The type of the audience.", -"enum": [ -"AUDIENCE_TYPE_UNSPECIFIED", -"CUSTOMER_MATCH_CONTACT_INFO", -"CUSTOMER_MATCH_DEVICE_ID", -"CUSTOMER_MATCH_USER_ID", -"ACTIVITY_BASED", -"FREQUENCY_CAP", -"TAG_BASED", -"YOUTUBE_USERS", -"LICENSED" -], -"enumDeprecated": [ -false, -false, -false, -false, -true, -true, -false, -false, -false -], -"enumDescriptions": [ -"Default value when type is not specified or is unknown.", -"Audience was generated through matching customers to known contact information.", -"Audience was generated through matching customers to known Mobile device IDs.", -"Audience was generated through matching customers to known User IDs.", -"Audience was created based on campaign activity.", -"Audience was created based on excluding the number of impressions they were served.", -"Audience was created based on custom variables attached to pixel.", -"Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", -"Subtype of third party audience type." -], -"type": "string" -}, -"contactInfoList": { -"$ref": "ContactInfoList", -"description": "Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`" -}, -"description": { -"description": "The user-provided description of the audience. Only applicable to first party audiences.", -"type": "string" -}, -"displayAudienceSize": { -"description": "Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"displayDesktopAudienceSize": { -"description": "Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"displayMobileAppAudienceSize": { -"description": "Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"displayMobileWebAudienceSize": { -"description": "Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "The display name of the first and third party audience.", -"type": "string" -}, -"firstAndThirdPartyAudienceId": { -"description": "Output only. The unique ID of the first and third party audience. Assigned by the system.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"firstAndThirdPartyAudienceType": { -"description": "Whether the audience is a first or third party audience.", -"enum": [ -"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_UNSPECIFIED", -"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_FIRST_PARTY", -"FIRST_AND_THIRD_PARTY_AUDIENCE_TYPE_THIRD_PARTY" -], -"enumDescriptions": [ -"Default value when type is not specified or is unknown.", -"Audience that is created via usage of client data.", -"Audience that is provided by Third Party data providers." -], -"type": "string" -}, -"gmailAudienceSize": { -"description": "Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"membershipDurationDays": { -"description": "The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`", -"format": "int64", -"type": "string" -}, -"mobileDeviceIdList": { -"$ref": "MobileDeviceIdList", -"description": "Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`" -}, -"name": { -"description": "Output only. The resource name of the first and third party audience.", -"readOnly": true, -"type": "string" -}, -"youtubeAudienceSize": { -"description": "Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "FirstAndThirdPartyAudienceGroup": { "description": "Details of first and third party audience group. All first and third party audience targeting settings are logically \u2018OR\u2019 of each other.", "id": "FirstAndThirdPartyAudienceGroup", @@ -18774,7 +18296,7 @@ false }, "demandGenSettings": { "$ref": "DemandGenSettings", -"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items." }, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", @@ -18877,7 +18399,7 @@ false "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"Demand Gen ads." ], "type": "string" }, @@ -19325,23 +18847,6 @@ false }, "type": "object" }, -"ListFirstAndThirdPartyAudiencesResponse": { -"id": "ListFirstAndThirdPartyAudiencesResponse", -"properties": { -"firstAndThirdPartyAudiences": { -"description": "The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.", -"items": { -"$ref": "FirstAndThirdPartyAudience" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results.", -"type": "string" -} -}, -"type": "object" -}, "ListFloodlightActivitiesResponse": { "id": "ListFloodlightActivitiesResponse", "properties": { @@ -19850,24 +19355,6 @@ false }, "type": "object" }, -"MobileDeviceIdList": { -"description": "Wrapper message for a list of mobile device IDs defining Customer Match audience members.", -"id": "MobileDeviceIdList", -"properties": { -"consent": { -"$ref": "Consent", -"description": "Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." -}, -"mobileDeviceIds": { -"description": "A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "NativeContentPositionAssignedTargetingOptionDetails": { "description": "Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect.", "id": "NativeContentPositionAssignedTargetingOptionDetails", @@ -21790,7 +21277,7 @@ false "type": "boolean" }, "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups.", "type": "boolean" } }, @@ -22065,7 +21552,7 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", "items": { "$ref": "ThirdPartyVendorConfig" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v4.json b/googleapiclient/discovery_cache/documents/displayvideo.v4.json index 2aa8d27e99..7bad212e65 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v4.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v4.json @@ -562,7 +562,7 @@ "adGroupAds": { "methods": { "create": { -"description": "Creates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Creates an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroupAds.create", @@ -591,7 +591,7 @@ ] }, "delete": { -"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroupAds.delete", @@ -708,7 +708,7 @@ ] }, "patch": { -"description": "Updates an ad group ad. This method is only supported for Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Updates an ad group ad. This method is only supported for Demand Gen ads.", "flatPath": "v4/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroupAds.patch", @@ -756,7 +756,7 @@ "adGroups": { "methods": { "bulkEditAssignedTargetingOptions": { -"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Bulk edits targeting options for multiple ad groups. The same set of delete and create requests will be applied to all specified ad groups. Specifically, the operation will delete the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.delete_requests from each ad group, and then create the assigned targeting options provided in BulkEditAdGroupAssignedTargetingOptionsRequest.create_requests. This method is only supported for Demand Gen ad groups.", "flatPath": "v4/advertisers/{advertisersId}/adGroups:bulkEditAssignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.bulkEditAssignedTargetingOptions", @@ -839,7 +839,7 @@ ] }, "create": { -"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Creates a new ad group. Returns the newly created ad group if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v4/advertisers/{advertisersId}/adGroups", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.create", @@ -868,7 +868,7 @@ ] }, "delete": { -"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes a AdGroup. Returns error code `NOT_FOUND` if the ad group does not exist. This method is only supported for Demand Gen ad groups.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.delete", @@ -985,7 +985,7 @@ ] }, "patch": { -"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Updates an existing ad group. Returns the updated ad group if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}", "httpMethod": "PATCH", "id": "displayvideo.advertisers.adGroups.patch", @@ -1035,7 +1035,7 @@ "assignedTargetingOptions": { "methods": { "create": { -"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Assigns a targeting option to an ad group. Returns the assigned targeting option if successful. This method is only supported for Demand Gen ad groups.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", "httpMethod": "POST", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.create", @@ -1187,7 +1187,7 @@ ] }, "delete": { -"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`. Retrieval and management of Demand Gen resources is currently rolling out. This method will be available to all partners by *June 24, 2026*.", +"description": "Deletes an assigned targeting option from an ad group. This method is only supported for Demand Gen ad groups with the AdGroupFormat `AD_GROUP_FORMAT_DEMAND_GEN`.", "flatPath": "v4/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", "httpMethod": "DELETE", "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.delete", @@ -5123,7 +5123,7 @@ "type": "string" }, "filter": { -"description": "Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` Examples: * All plannable user lists: `plannableStatus=\"PLANNABLE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", +"description": "Optional. Allows filtering by plannable user list properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `displayName` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `plannableStatus` * `displayName` * `userListType` * `name` Examples: * All plannable user lists: `plannableStatus=\"PLANNABLE\"` * Plannable user lists with display name containing \"Shopping\": `plannableStatus=\"PLANNABLE\" AND displayName:\"Shopping\"` * First party user lists: `userListType=\"FIRST_PARTY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", "location": "query", "type": "string" }, @@ -9574,7 +9574,7 @@ } } }, -"revision": "20260623", +"revision": "20260708", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -9776,7 +9776,7 @@ "Responsive ads.", "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", "Masthead Ad that is surfaced on the top slot on the YouTube homepage.", -"Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"Demand Gen ads." ], "type": "string" }, @@ -9891,23 +9891,23 @@ }, "dcmTrackingInfo": { "$ref": "DcmTrackingInfo", -"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Optional. The DCM tracking ad info. Only valid for Demand Gen ads. To remove the DCM tracking ad info, please leave this field empty." }, "demandGenCarouselAd": { "$ref": "DemandGenCarouselAd", -"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen carousel ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#CarouselAd)." }, "demandGenImageAd": { "$ref": "DemandGenImageAd", -"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen image ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#ImageAd)." }, "demandGenProductAd": { "$ref": "DemandGenProductAd", -"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen product ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#Product-onlyAd)." }, "demandGenVideoAd": { "$ref": "DemandGenVideoAd", -"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd). Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Details of a [Demand Gen video ad](//support.google.com/displayvideo/answer/15598924?&sjid=11207068802760924844-NC#VideoAd)." }, "displayName": { "description": "Required. The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", @@ -11033,6 +11033,22 @@ }, "type": "array" }, +"network": { +"description": "Optional. The network to target.", +"enum": [ +"PLANNABLE_NETWORK_UNSPECIFIED", +"PLANNABLE_NETWORK_YOUTUBE", +"PLANNABLE_NETWORK_GOOGLE_VIDEO_PARTNERS", +"PLANNABLE_NETWORK_YOUTUBE_AND_GOOGLE_VIDEO_PARTNERS" +], +"enumDescriptions": [ +"Not specified.", +"YouTube.", +"Google Video Partners.", +"YouTube and Google Video Partners." +], +"type": "string" +}, "plannableLocationIds": { "description": "Optional. Plannable location IDs to target.", "items": { @@ -14209,33 +14225,33 @@ "id": "ContactInfo", "properties": { "countryCode": { -"description": "Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes", +"description": "Optional. Country code of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name * zip_codes", "type": "string" }, "hashedEmails": { -"description": "A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.", +"description": "Optional. A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.", "items": { "type": "string" }, "type": "array" }, "hashedFirstName": { -"description": "SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes", +"description": "Optional. SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes", "type": "string" }, "hashedLastName": { -"description": "SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes", +"description": "Optional. SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes", "type": "string" }, "hashedPhoneNumbers": { -"description": "A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.", +"description": "Optional. A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](https://en.wikipedia.org/wiki/E.164) and include the country calling code.", "items": { "type": "string" }, "type": "array" }, "zipCodes": { -"description": "A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name", +"description": "Optional. A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name", "items": { "type": "string" }, @@ -14253,7 +14269,7 @@ "description": "Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." }, "contactInfos": { -"description": "A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.", +"description": "Optional. A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn't be greater than 500,000.", "items": { "$ref": "ContactInfo" }, @@ -14671,7 +14687,7 @@ "type": "string" }, "primaryAttributionModelId": { -"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. The attribution model to use for conversion measurement. This attribution model will determine how conversions are counted. The Primary model can be set by you for a floodlight config or group. More details [here](https://support.google.com/displayvideo/answer/7409983). Only applicable to Demand Gen line items.", "format": "int64", "type": "string" } @@ -16105,7 +16121,7 @@ false "id": "DemandGenCarouselAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "cards": { @@ -16140,7 +16156,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -16159,7 +16175,7 @@ false "id": "DemandGenImageAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16200,7 +16216,7 @@ false "type": "array" }, "logoImages": { -"description": "The list of logo images shown on the ad.", +"description": "The list of logo images shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "items": { "$ref": "ImageAsset" }, @@ -16244,7 +16260,7 @@ false "id": "DemandGenProductAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16326,7 +16342,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "trackingUrl": { "description": "Output only. The URL address loaded in the background for tracking purposes.", @@ -16365,7 +16381,7 @@ false "id": "DemandGenVideoAd", "properties": { "businessName": { -"description": "Required. The business name shown on the ad.", +"description": "Required. The business name shown on the ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied.", "type": "string" }, "callToAction": { @@ -16461,7 +16477,7 @@ false }, "logo": { "$ref": "ImageAsset", -"description": "Required. The logo image used by this ad." +"description": "Required. The logo image used by this ad. *Warning*: Starting **July 13, 2026**, this setting will no longer be required if a default value is set at the advertiser level. If left unset, the default value will be applied." }, "longHeadlines": { "description": "Required. The list of long headlines shown on the ad.", @@ -17053,7 +17069,7 @@ false "type": "object" }, "EditCustomerMatchMembersRequest": { -"description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", +"description": "Request message for FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers.", "id": "EditCustomerMatchMembersRequest", "properties": { "addedContactInfoList": { @@ -17081,7 +17097,7 @@ false "type": "object" }, "EditCustomerMatchMembersResponse": { -"description": "The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", +"description": "The response of FirstPartyAndPartnerAudienceService.EditCustomerMatchMembers.", "id": "EditCustomerMatchMembersResponse", "properties": { "firstPartyAndPartnerAudienceId": { @@ -17185,38 +17201,6 @@ false }, "type": "object" }, -"EffectiveFrequencyBreakdown": { -"description": "A breakdown of the number of unique people reached at a given effective frequency.", -"id": "EffectiveFrequencyBreakdown", -"properties": { -"effectiveCoviewReach": { -"description": "The number of unique individuals, including co-viewers, exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency.", -"format": "int64", -"type": "string" -}, -"effectiveFrequency": { -"description": "The set effective frequency.", -"format": "int32", -"type": "integer" -}, -"onTargetEffectiveCoviewReach": { -"description": "The total number of unique individuals, including co-viewers that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting.", -"format": "int64", -"type": "string" -}, -"onTargetReach": { -"description": "The number of unique individuals exactly matching the targeting that were served the ad at least the number of times dictated by the effective_frequency.", -"format": "int64", -"type": "string" -}, -"totalReach": { -"description": "The total number of unique individuals that were served the ad at least the number of times dictated by the effective_frequency. This includes individuals that may fall outside of targeting.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "Empty": { "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", @@ -18201,8 +18185,8 @@ false "Audience was generated through matching customers to known contact information.", "Audience was generated through matching customers to known Mobile device IDs.", "Audience was generated through matching customers to known User IDs.", -"Audience was created based on campaign activity.", -"Audience was created based on excluding the number of impressions they were served.", +"Deprecated: Audience was created based on campaign activity.", +"Deprecated: Audience was created based on excluding the number of impressions they were served.", "Audience was created based on custom variables attached to pixel.", "Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", "Audience has been licensed for use from a third party.", @@ -18636,13 +18620,8 @@ false "description": "Required. The currency code for the plan in ISO 4217 format.", "type": "string" }, -"effectiveFrequencyBreakdownLimit": { -"description": "Optional. The highest minimum effective frequency to include in PlannedProductForecast.effective_frequency_breakdowns. Must be between 1 and 10, inclusive. If not specified, PlannedProductForecast.effective_frequency_breakdowns will not be populated. If set, this value will also be used as the minimum effective frequency for reach metrics reporting. This field cannot be combined with the min_effective_frequency field.", -"format": "int32", -"type": "integer" -}, "minEffectiveFrequency": { -"description": "Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied. This field cannot be combined with effective_frequency_breakdown_limit.", +"description": "Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied.", "format": "int32", "type": "integer" }, @@ -20746,7 +20725,7 @@ false }, "demandGenSettings": { "$ref": "DemandGenSettings", -"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"description": "Optional. Settings specific to Demand Gen line items. Only applicable to Demand Gen line items." }, "displayName": { "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", @@ -20849,7 +20828,7 @@ false "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", -"Demand Gen ads. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*." +"Demand Gen ads." ], "type": "string" }, @@ -21886,7 +21865,7 @@ false "description": "Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error." }, "mobileDeviceIds": { -"description": "A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.", +"description": "Optional. A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000.", "items": { "type": "string" }, @@ -22933,6 +22912,12 @@ false "readOnly": true, "type": "string" }, +"parentPlannableLocationId": { +"description": "Output only. The parent plannable location ID, for example the country ID for subgeos.", +"format": "int64", +"readOnly": true, +"type": "string" +}, "plannableLocationId": { "description": "Output only. The plannable location ID.", "format": "int64", @@ -22947,6 +22932,62 @@ false }, "type": "object" }, +"PlannableProductCoreAttributes": { +"description": "Core attributes for a plannable product.", +"id": "PlannableProductCoreAttributes", +"properties": { +"buyingMethod": { +"description": "Output only. The buying method.", +"enum": [ +"PLANNABLE_BUYING_METHOD_UNSPECIFIED", +"PLANNABLE_BUYING_METHOD_AUCTION", +"PLANNABLE_BUYING_METHOD_RESERVATION" +], +"enumDescriptions": [ +"Not specified.", +"Auction.", +"Reservation." +], +"readOnly": true, +"type": "string" +}, +"costModel": { +"description": "Output only. The cost model.", +"enum": [ +"PLANNABLE_COST_MODEL_UNSPECIFIED", +"PLANNABLE_COST_MODEL_CPM", +"PLANNABLE_COST_MODEL_CPV", +"PLANNABLE_COST_MODEL_CPC", +"PLANNABLE_COST_MODEL_CPA" +], +"enumDescriptions": [ +"Not specified.", +"CPM.", +"CPV.", +"CPC.", +"CPA." +], +"readOnly": true, +"type": "string" +}, +"productCategory": { +"description": "Output only. The product category.", +"enum": [ +"PLANNABLE_PRODUCT_CATEGORY_UNSPECIFIED", +"YOUTUBE", +"OPEN_AUCTION" +], +"enumDescriptions": [ +"Not specified.", +"YouTube.", +"Open Auction." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "PlannableTargeting": { "description": "Targeting capabilities for a given product.", "id": "PlannableTargeting", @@ -23027,6 +23068,11 @@ false "readOnly": true, "type": "array" }, +"defaultYoutubeSelectLineup": { +"$ref": "YouTubeSelectLineUp", +"description": "Output only. The default YouTube Select Lineup for this product, if applicable.", +"readOnly": true +}, "devices": { "description": "Output only. Targetable devices for the ad product.", "items": { @@ -23071,9 +23117,8 @@ false "readOnly": true, "type": "array" }, -"networks": { -"description": "Output only. Targetable networks for the ad product.", -"items": { +"network": { +"description": "Output only. Targetable network for the ad product.", "enum": [ "PLANNABLE_NETWORK_UNSPECIFIED", "PLANNABLE_NETWORK_YOUTUBE", @@ -23086,10 +23131,8 @@ false "Google Video Partners.", "YouTube and Google Video Partners." ], -"type": "string" -}, "readOnly": true, -"type": "array" +"type": "string" }, "surfaceTargetingCombinations": { "$ref": "SurfaceTargetingCombinations", @@ -23205,13 +23248,6 @@ false "description": "Performance metrics for a forecast point.", "id": "PlannedProductForecast", "properties": { -"effectiveFrequencyBreakdowns": { -"description": "A list of effective frequency breakdowns.", -"items": { -"$ref": "EffectiveFrequencyBreakdown" -}, -"type": "array" -}, "onTargetImpressions": { "description": "Number of on-target impressions.", "format": "int64", @@ -23466,6 +23502,11 @@ false "readOnly": true, "type": "string" }, +"plannableProductCoreAttributes": { +"$ref": "PlannableProductCoreAttributes", +"description": "Output only. Core attributes for this product.", +"readOnly": true +}, "plannableProductDescription": { "description": "Output only. The plain-text description of the ad product.", "readOnly": true, @@ -24385,6 +24426,38 @@ false "readOnly": true, "type": "array" }, +"defaultSurfaceTypes": { +"description": "Output only. The default surface types for this product.", +"items": { +"enum": [ +"PLANNABLE_SURFACE_UNSPECIFIED", +"PLANNABLE_SURFACE_IN_FEED", +"PLANNABLE_SURFACE_IN_STREAM_BUMPER", +"PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE", +"PLANNABLE_SURFACE_IN_STREAM_SKIPPABLE", +"PLANNABLE_SURFACE_SHORTS", +"PLANNABLE_SURFACE_DISCOVER_FEED", +"PLANNABLE_SURFACE_GMAIL", +"PLANNABLE_SURFACE_GOOGLE_DISPLAY_NETWORK", +"PLANNABLE_SURFACE_IN_STREAM_NON_SKIPPABLE_THIRTY_SECONDS" +], +"enumDescriptions": [ +"Not specified.", +"In-feed.", +"In-stream bumper.", +"In-stream non-skippable.", +"In-stream skippable.", +"Shorts.", +"Discover feed.", +"Gmail.", +"Google Display Network.", +"In-stream non-skippable (30 seconds)." +], +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "validSurfaceCombinations": { "description": "Output only. Valid combinations of surfaces that can be selected together.", "items": { @@ -24644,7 +24717,7 @@ false "type": "boolean" }, "excludeDemographicExpansion": { -"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups. Retrieval and management of Demand Gen resources is currently rolling out. This field will be available to all partners by *June 24, 2026*.", +"description": "Optional. Whether to exclude demographic expansion for Optimized Targeting. This field can only be set for Demand Gen ad groups.", "type": "boolean" } }, @@ -24919,7 +24992,7 @@ false "id": "ThirdPartyMeasurementConfigs", "properties": { "brandLiftVendorConfigs": { -"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`", +"description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL` *Warning*: Starting **July 13, 2026**, this field will no longer support `THIRD_PARTY_VENDOR_NIELSEN`.", "items": { "$ref": "ThirdPartyVendorConfig" }, From 2180151f18ba7da1ed522bb3aeb4cea9b0ca3ab9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:57 +0000 Subject: [PATCH 32/50] feat(dlp): update the api #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2DlpJob.properties.createTime.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.endTime.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.errors.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.jobTriggerName.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.lastModified.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.name.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.startTime.readOnly (Total Keys: 1) - schemas.GooglePrivacyDlpV2DlpJob.properties.state.readOnly (Total Keys: 1) --- ...lp_v2.organizations.locations.dlpJobs.html | 16 +++---- docs/dyn/dlp_v2.projects.dlpJobs.html | 48 +++++++++---------- docs/dyn/dlp_v2.projects.jobTriggers.html | 16 +++---- .../dlp_v2.projects.locations.dlpJobs.html | 48 +++++++++---------- ...dlp_v2.projects.locations.jobTriggers.html | 16 +++---- .../discovery_cache/documents/dlp.v2.json | 26 ++++++---- 6 files changed, 89 insertions(+), 81 deletions(-) diff --git a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html index 08e2cb03b3..f86e329828 100644 --- a/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.organizations.locations.dlpJobs.html @@ -2715,9 +2715,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3408,9 +3408,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -3967,8 +3967,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }, ], diff --git a/docs/dyn/dlp_v2.projects.dlpJobs.html b/docs/dyn/dlp_v2.projects.dlpJobs.html index 7df6fe6223..073a823215 100644 --- a/docs/dyn/dlp_v2.projects.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.dlpJobs.html @@ -3302,9 +3302,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3995,9 +3995,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -4554,8 +4554,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
@@ -7192,9 +7192,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -7885,9 +7885,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -8444,8 +8444,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
@@ -11076,9 +11076,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -11769,9 +11769,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -12328,8 +12328,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }, ], diff --git a/docs/dyn/dlp_v2.projects.jobTriggers.html b/docs/dyn/dlp_v2.projects.jobTriggers.html index 9795ab3647..1c0f042034 100644 --- a/docs/dyn/dlp_v2.projects.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.jobTriggers.html @@ -2719,9 +2719,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3412,9 +3412,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -3971,8 +3971,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
diff --git a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html index 1dc3b79985..7f72d9cbee 100644 --- a/docs/dyn/dlp_v2.projects.locations.dlpJobs.html +++ b/docs/dyn/dlp_v2.projects.locations.dlpJobs.html @@ -3308,9 +3308,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -4001,9 +4001,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -4560,8 +4560,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
@@ -7222,9 +7222,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -7915,9 +7915,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -8474,8 +8474,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
@@ -11252,9 +11252,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -11945,9 +11945,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -12504,8 +12504,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }, ], diff --git a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html index 970bd21840..080ad2b812 100644 --- a/docs/dyn/dlp_v2.projects.locations.jobTriggers.html +++ b/docs/dyn/dlp_v2.projects.locations.jobTriggers.html @@ -2722,9 +2722,9 @@

Method Details

}, }, ], - "createTime": "A String", # Time when the job was created. - "endTime": "A String", # Time when the job finished. - "errors": [ # A stream of errors encountered running the job. + "createTime": "A String", # Output only. Time when the job was created. + "endTime": "A String", # Output only. Time when the job finished. + "errors": [ # Output only. A stream of errors encountered running the job. { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger. "details": { # 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). # Detailed error codes and messages. "code": 42, # The status code, which should be an enum value of google.rpc.Code. @@ -3415,9 +3415,9 @@

Method Details

"totalEstimatedBytes": "A String", # Estimate of the number of bytes to process. }, }, - "jobTriggerName": "A String", # If created by a job trigger, the resource name of the trigger that instantiated the job. - "lastModified": "A String", # Time when the job was last modified by the system. - "name": "A String", # The server-assigned name. + "jobTriggerName": "A String", # Output only. If created by a job trigger, the resource name of the trigger that instantiated the job. + "lastModified": "A String", # Output only. Time when the job was last modified by the system. + "name": "A String", # Output only. The server-assigned name. "riskDetails": { # Result of a risk analysis operation request. # Results from analyzing risk of a data source. "categoricalStatsResult": { # Result of the categorical stats computation. # Categorical stats result "valueFrequencyHistogramBuckets": [ # Histogram of value frequencies in the column. @@ -3974,8 +3974,8 @@

Method Details

"tableId": "A String", # Name of the table. }, }, - "startTime": "A String", # Time when the job started. - "state": "A String", # State of a job. + "startTime": "A String", # Output only. Time when the job started. + "state": "A String", # Output only. State of a job. "type": "A String", # The type of job. }
diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 9a6a16716c..cd047096bd 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -5274,7 +5274,7 @@ } } }, -"revision": "20260620", +"revision": "20260704", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -8686,20 +8686,23 @@ "type": "array" }, "createTime": { -"description": "Time when the job was created.", +"description": "Output only. Time when the job was created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "endTime": { -"description": "Time when the job finished.", +"description": "Output only. Time when the job finished.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "errors": { -"description": "A stream of errors encountered running the job.", +"description": "Output only. A stream of errors encountered running the job.", "items": { "$ref": "GooglePrivacyDlpV2Error" }, +"readOnly": true, "type": "array" }, "inspectDetails": { @@ -8707,16 +8710,19 @@ "description": "Results from inspecting a data source." }, "jobTriggerName": { -"description": "If created by a job trigger, the resource name of the trigger that instantiated the job.", +"description": "Output only. If created by a job trigger, the resource name of the trigger that instantiated the job.", +"readOnly": true, "type": "string" }, "lastModified": { -"description": "Time when the job was last modified by the system.", +"description": "Output only. Time when the job was last modified by the system.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "name": { -"description": "The server-assigned name.", +"description": "Output only. The server-assigned name.", +"readOnly": true, "type": "string" }, "riskDetails": { @@ -8724,12 +8730,13 @@ "description": "Results from analyzing risk of a data source." }, "startTime": { -"description": "Time when the job started.", +"description": "Output only. Time when the job started.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "state": { -"description": "State of a job.", +"description": "Output only. State of a job.", "enum": [ "JOB_STATE_UNSPECIFIED", "PENDING", @@ -8748,6 +8755,7 @@ "The job had an error and did not complete.", "The job is currently accepting findings via hybridInspect. A hybrid job in ACTIVE state may continue to have findings added to it through the calling of hybridInspect. After the job has finished no more calls to hybridInspect may be made. ACTIVE jobs can transition to DONE." ], +"readOnly": true, "type": "string" }, "type": { From d348095bbc1ad9906c643c17136b1542ad99f3bd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:58 +0000 Subject: [PATCH 33/50] feat(firestore): update the api #### firestore:v1 The following keys were added: - resources.projects.resources.databases.resources.documents.methods.createDocument.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.delete.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.get.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.list.parameters.recursive (Total Keys: 2) - resources.projects.resources.databases.resources.documents.methods.list.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.recursive (Total Keys: 2) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.patch.parameters.requestOptions.requestTags (Total Keys: 3) - schemas.BatchGetDocumentsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BatchWriteRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BeginTransactionRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.CommitRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ExecutePipelineRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListCollectionIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListenRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.PartitionQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RequestOptions (Total Keys: 4) - schemas.RollbackRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.WriteRequest.properties.requestOptions.$ref (Total Keys: 1) #### firestore:v1beta1 The following keys were added: - resources.projects.resources.databases.resources.documents.methods.createDocument.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.delete.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.get.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.list.parameters.recursive (Total Keys: 2) - resources.projects.resources.databases.resources.documents.methods.list.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.recursive (Total Keys: 2) - resources.projects.resources.databases.resources.documents.methods.listDocuments.parameters.requestOptions.requestTags (Total Keys: 3) - resources.projects.resources.databases.resources.documents.methods.patch.parameters.requestOptions.requestTags (Total Keys: 3) - schemas.BatchGetDocumentsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BatchWriteRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.BeginTransactionRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.CommitRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ExecutePipelineRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListCollectionIdsRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.ListenRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.PartitionQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RequestOptions (Total Keys: 4) - schemas.RollbackRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunAggregationQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.RunQueryRequest.properties.requestOptions.$ref (Total Keys: 1) - schemas.WriteRequest.properties.requestOptions.$ref (Total Keys: 1) --- ...store_v1.projects.databases.documents.html | 92 +++++++++++++-- ..._v1beta1.projects.databases.documents.html | 92 +++++++++++++-- .../documents/firestore.v1.json | 110 +++++++++++++++++- .../documents/firestore.v1beta1.json | 110 +++++++++++++++++- 4 files changed, 378 insertions(+), 26 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index 58f444ccff..cc75153f12 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -90,19 +90,19 @@

Instance Methods

commit(database, body=None, x__xgafv=None)

Commits a transaction, while optionally updating documents.

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)

+ createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)

Creates a new document.

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)

+ delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)

Deletes a document.

executePipeline(database, body=None, x__xgafv=None)

Executes a pipeline query.

- get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)

+ get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)

Gets a single document.

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None)

+ list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listCollectionIds(parent, body=None, x__xgafv=None)

@@ -111,7 +111,7 @@

Instance Methods

listCollectionIds_next()

Retrieves the next page of results.

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None)

+ listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listDocuments_next()

@@ -129,7 +129,7 @@

Instance Methods

partitionQuery_next()

Retrieves the next page of results.

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)

+ patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)

Updates or inserts a document.

rollback(database, body=None, x__xgafv=None)

@@ -172,6 +172,11 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # Reads documents in a transaction. } @@ -258,6 +263,11 @@

Method Details

"labels": { # Labels associated with this batch write. "a_key": "A String", }, + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "writes": [ # The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. { # A write on a document. "currentDocument": { # A precondition on a document, used for conditional operations. # An optional precondition on the document. The write will fail if this is set and not met by the target document. @@ -749,6 +759,11 @@

Method Details

"retryTransaction": "A String", # An optional transaction to retry. }, }, + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -779,6 +794,11 @@

Method Details

The object takes the form of: { # The request for Firestore.Commit. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # If set, applies all writes in this transaction, and commits it. "writes": [ # The writes to apply. Always executed atomically and in order. { # A write on a document. @@ -1243,7 +1263,7 @@

Method Details

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None) + createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)
Creates a new document.
 
 Args:
@@ -1310,6 +1330,7 @@ 

Method Details

documentId: string, The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1376,13 +1397,14 @@

Method Details

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None) + delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)
Deletes a document.
 
 Args:
   name: string, Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
   currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
+  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1416,6 +1438,11 @@ 

Method Details

}, }, "readTime": "A String", # Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredPipeline": { # A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. # A pipelined operation. "options": { # Optional. Optional query-level arguments. "a_key": { # A message that can hold any of the supported value types. @@ -1561,13 +1588,14 @@

Method Details

- get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None) + get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)
Gets a single document.
 
 Args:
   name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
   readTime: string, Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
+  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   transaction: string, Reads the document in a transaction.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1635,7 +1663,7 @@ 

Method Details

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None) + list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1646,6 +1674,8 @@ 

Method Details

pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -1731,6 +1761,11 @@

Method Details

"pageSize": 42, # The maximum number of results to return. "pageToken": "A String", # A page token. Must be a value from ListCollectionIdsResponse. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -1764,7 +1799,7 @@

Method Details

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None) + listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1775,6 +1810,8 @@ 

Method Details

pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -2160,6 +2197,11 @@

Method Details

"a_key": "A String", }, "removeTarget": 42, # The ID of a target to remove from this stream. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -2293,6 +2335,11 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -2634,7 +2681,7 @@

Method Details

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None) + patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)
Updates or inserts a document.
 
 Args:
@@ -2701,6 +2748,7 @@ 

Method Details

currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist. currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) updateMask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) x__xgafv: string, V1 error format. Allowed values @@ -2777,6 +2825,11 @@

Method Details

The object takes the form of: { # The request for Firestore.Rollback. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # Required. The transaction to roll back. } @@ -2815,6 +2868,11 @@

Method Details

}, }, "readTime": "A String", # Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredAggregationQuery": { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query. "aggregations": [ # Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query. { # Defines an aggregation that produces a single result. @@ -3200,6 +3258,11 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -3560,6 +3623,11 @@

Method Details

"labels": { # Labels associated with this write request. "a_key": "A String", }, + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "streamId": "A String", # The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. "streamToken": "A String", # A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. "writes": [ # The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index 3bb5696e83..6c5f1174b2 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -90,19 +90,19 @@

Instance Methods

commit(database, body=None, x__xgafv=None)

Commits a transaction, while optionally updating documents.

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None)

+ createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)

Creates a new document.

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None)

+ delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)

Deletes a document.

executePipeline(database, body=None, x__xgafv=None)

Executes a pipeline query.

- get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None)

+ get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)

Gets a single document.

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None)

+ list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listCollectionIds(parent, body=None, x__xgafv=None)

@@ -111,7 +111,7 @@

Instance Methods

listCollectionIds_next()

Retrieves the next page of results.

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None)

+ listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)

Lists documents.

listDocuments_next()

@@ -129,7 +129,7 @@

Instance Methods

partitionQuery_next()

Retrieves the next page of results.

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None)

+ patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)

Updates or inserts a document.

rollback(database, body=None, x__xgafv=None)

@@ -172,6 +172,11 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # Reads documents in a transaction. } @@ -258,6 +263,11 @@

Method Details

"labels": { # Labels associated with this batch write. "a_key": "A String", }, + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "writes": [ # The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request. { # A write on a document. "currentDocument": { # A precondition on a document, used for conditional operations. # An optional precondition on the document. The write will fail if this is set and not met by the target document. @@ -749,6 +759,11 @@

Method Details

"retryTransaction": "A String", # An optional transaction to retry. }, }, + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -779,6 +794,11 @@

Method Details

The object takes the form of: { # The request for Firestore.Commit. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # If set, applies all writes in this transaction, and commits it. "writes": [ # The writes to apply. Always executed atomically and in order. { # A write on a document. @@ -1243,7 +1263,7 @@

Method Details

- createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, x__xgafv=None) + createDocument(parent, collectionId, body=None, documentId=None, mask_fieldPaths=None, requestOptions_requestTags=None, x__xgafv=None)
Creates a new document.
 
 Args:
@@ -1310,6 +1330,7 @@ 

Method Details

documentId: string, The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1376,13 +1397,14 @@

Method Details

- delete(name, currentDocument_exists=None, currentDocument_updateTime=None, x__xgafv=None) + delete(name, currentDocument_exists=None, currentDocument_updateTime=None, requestOptions_requestTags=None, x__xgafv=None)
Deletes a document.
 
 Args:
   name: string, Required. The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
   currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned.
+  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1416,6 +1438,11 @@ 

Method Details

}, }, "readTime": "A String", # Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredPipeline": { # A Firestore query represented as an ordered list of operations / stages. This is considered the top-level function which plans and executes a query. It is logically equivalent to `query(stages, options)`, but prevents the client from having to build a function wrapper. # A pipelined operation. "options": { # Optional. Optional query-level arguments. "a_key": { # A message that can hold any of the supported value types. @@ -1561,13 +1588,14 @@

Method Details

- get(name, mask_fieldPaths=None, readTime=None, transaction=None, x__xgafv=None) + get(name, mask_fieldPaths=None, readTime=None, requestOptions_requestTags=None, transaction=None, x__xgafv=None)
Gets a single document.
 
 Args:
   name: string, Required. The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`. (required)
   mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
   readTime: string, Reads the version of the document at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
+  requestOptions_requestTags: string, Optional. The request tags for the request. (repeated)
   transaction: string, Reads the document in a transaction.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1635,7 +1663,7 @@ 

Method Details

- list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None) + list(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1646,6 +1674,8 @@ 

Method Details

pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -1731,6 +1761,11 @@

Method Details

"pageSize": 42, # The maximum number of results to return. "pageToken": "A String", # A page token. Must be a value from ListCollectionIdsResponse. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -1764,7 +1799,7 @@

Method Details

- listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, showMissing=None, transaction=None, x__xgafv=None) + listDocuments(parent, collectionId, mask_fieldPaths=None, orderBy=None, pageSize=None, pageToken=None, readTime=None, recursive=None, requestOptions_requestTags=None, showMissing=None, transaction=None, x__xgafv=None)
Lists documents.
 
 Args:
@@ -1775,6 +1810,8 @@ 

Method Details

pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. readTime: string, Perform the read at the provided time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + recursive: boolean, Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`. + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. @@ -2160,6 +2197,11 @@

Method Details

"a_key": "A String", }, "removeTarget": 42, # The ID of a target to remove from this stream. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, } x__xgafv: string, V1 error format. @@ -2293,6 +2335,11 @@

Method Details

"pageToken": "A String", # The `next_page_token` value returned from a previous call to PartitionQuery that may be used to get an additional set of results. There are no ordering guarantees between sets of results. Thus, using multiple sets of results will require merging the different result sets. For example, two subsequent calls using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, cursor U, cursor W To obtain a complete result set ordered with respect to the results of the query supplied to PartitionQuery, the results sets should be merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W "partitionCount": "A String", # The desired maximum number of partition points. The partitions may be returned across multiple pages of results. The number must be positive. The actual number of partitions returned may be fewer. For example, this may be set to one fewer than the number of parallel queries to be run, or in running a data pipeline job, one fewer than the number of workers or compute instances available. "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -2634,7 +2681,7 @@

Method Details

- patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, updateMask_fieldPaths=None, x__xgafv=None) + patch(name, body=None, currentDocument_exists=None, currentDocument_updateTime=None, mask_fieldPaths=None, requestOptions_requestTags=None, updateMask_fieldPaths=None, x__xgafv=None)
Updates or inserts a document.
 
 Args:
@@ -2701,6 +2748,7 @@ 

Method Details

currentDocument_exists: boolean, When set to `true`, the target document must exist. When set to `false`, the target document must not exist. currentDocument_updateTime: string, When set, the target document must exist and have been last updated at that time. Timestamp must be microsecond aligned. mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) + requestOptions_requestTags: string, Optional. The request tags for the request. (repeated) updateMask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) x__xgafv: string, V1 error format. Allowed values @@ -2777,6 +2825,11 @@

Method Details

The object takes the form of: { # The request for Firestore.Rollback. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "transaction": "A String", # Required. The transaction to roll back. } @@ -2815,6 +2868,11 @@

Method Details

}, }, "readTime": "A String", # Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredAggregationQuery": { # Firestore query for running an aggregation over a StructuredQuery. # An aggregation query. "aggregations": [ # Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query. { # Defines an aggregation that produces a single result. @@ -3200,6 +3258,11 @@

Method Details

}, }, "readTime": "A String", # Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. + "requestOptions": { # Options for a server request. # Optional. The request options for this request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "structuredQuery": { # A Firestore query. The query stages are executed in the following order: 1. from 2. where 3. select 4. order_by + start_at + end_at 5. offset 6. limit 7. find_nearest # A structured query. "endAt": { # A position in a query result set. # A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause. "before": True or False, # If the position is just before or just after the given values, relative to the sort order defined by the query. @@ -3560,6 +3623,11 @@

Method Details

"labels": { # Labels associated with this write request. "a_key": "A String", }, + "requestOptions": { # Options for a server request. # Optional. The request options for the request. + "requestTags": [ # Optional. The request tags for the request. + "A String", + ], + }, "streamId": "A String", # The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created. "streamToken": "A String", # A stream token that was previously sent by the server. The client should set this field to the token from the most recent WriteResponse it has received. This acknowledges that the client has received responses up to this token. After sending this token, earlier tokens may not be used anymore. The server may close the stream if there are too many unacknowledged responses. Leave this field unset when creating a new stream. To resume a stream at a specific point, set this field and the `stream_id` field. Leave this field unset when creating a new stream. "writes": [ # The writes to apply. Always executed atomically and in order. This must be empty on the first request. This may be empty on the last request. This must not be empty on all other requests. diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 00ae35bc64..0ae336bc9e 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1403,6 +1403,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v1/{+parent}/{collectionId}", @@ -1443,6 +1449,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v1/{+name}", @@ -1511,6 +1523,12 @@ "location": "query", "type": "string" }, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -1578,6 +1596,17 @@ "location": "query", "type": "string" }, +"recursive": { +"description": "Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`.", +"location": "query", +"type": "boolean" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1679,6 +1708,17 @@ "location": "query", "type": "string" }, +"recursive": { +"description": "Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`.", +"location": "query", +"type": "boolean" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1791,6 +1831,12 @@ "required": true, "type": "string" }, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -2435,7 +2481,7 @@ } } }, -"revision": "20260608", +"revision": "20260702", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2524,6 +2570,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -2568,6 +2618,10 @@ "description": "Labels associated with this batch write.", "type": "object" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -2606,6 +2660,10 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." } }, "type": "object" @@ -2674,6 +2732,10 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -2938,6 +3000,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -5003,6 +5069,10 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." } }, "type": "object" @@ -5080,6 +5150,10 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." } }, "type": "object" @@ -5207,6 +5281,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -5347,10 +5425,28 @@ }, "type": "object" }, +"RequestOptions": { +"description": "Options for a server request.", +"id": "RequestOptions", +"properties": { +"requestTags": { +"description": "Optional. The request tags for the request.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -5376,6 +5472,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -5430,6 +5530,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -5878,6 +5982,10 @@ "description": "Labels associated with this write request.", "type": "object" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 9f9fe28b54..afcae1d346 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -775,6 +775,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/.*$", "required": true, "type": "string" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v1beta1/{+parent}/{collectionId}", @@ -815,6 +821,12 @@ "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$", "required": true, "type": "string" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" } }, "path": "v1beta1/{+name}", @@ -883,6 +895,12 @@ "location": "query", "type": "string" }, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "transaction": { "description": "Reads the document in a transaction.", "format": "byte", @@ -950,6 +968,17 @@ "location": "query", "type": "string" }, +"recursive": { +"description": "Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`.", +"location": "query", +"type": "boolean" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1051,6 +1080,17 @@ "location": "query", "type": "string" }, +"recursive": { +"description": "Optional. If the list should recursively include all documents nested under the parent at any level. If the request specifies a `collection_id`, then the list will include all nested documents in the collection under the parent. This is optional, and when not provided, Firestore will only list documents nested immediately under the parent. Requests with `recursive` may not specify `show_missing`.", +"location": "query", +"type": "boolean" +}, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "showMissing": { "description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.", "location": "query", @@ -1163,6 +1203,12 @@ "required": true, "type": "string" }, +"requestOptions.requestTags": { +"description": "Optional. The request tags for the request.", +"location": "query", +"repeated": true, +"type": "string" +}, "updateMask.fieldPaths": { "description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.", "location": "query", @@ -1431,7 +1477,7 @@ } } }, -"revision": "20260608", +"revision": "20260702", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1520,6 +1566,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "Reads documents in a transaction.", "format": "byte", @@ -1564,6 +1614,10 @@ "description": "Labels associated with this batch write.", "type": "object" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "writes": { "description": "The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.", "items": { @@ -1602,6 +1656,10 @@ "options": { "$ref": "TransactionOptions", "description": "The options for the transaction. Defaults to a read-write transaction." +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." } }, "type": "object" @@ -1670,6 +1728,10 @@ "description": "The request for Firestore.Commit.", "id": "CommitRequest", "properties": { +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "If set, applies all writes in this transaction, and commits it.", "format": "byte", @@ -1934,6 +1996,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "structuredPipeline": { "$ref": "StructuredPipeline", "description": "A pipelined operation." @@ -2868,6 +2934,10 @@ "description": "Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.", "format": "google-datetime", "type": "string" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." } }, "type": "object" @@ -2927,6 +2997,10 @@ "description": "The ID of a target to remove from this stream.", "format": "int32", "type": "integer" +}, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." } }, "type": "object" @@ -3020,6 +3094,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported." @@ -3160,10 +3238,28 @@ }, "type": "object" }, +"RequestOptions": { +"description": "Options for a server request.", +"id": "RequestOptions", +"properties": { +"requestTags": { +"description": "Optional. The request tags for the request.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "RollbackRequest": { "description": "The request for Firestore.Rollback.", "id": "RollbackRequest", "properties": { +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "transaction": { "description": "Required. The transaction to roll back.", "format": "byte", @@ -3189,6 +3285,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "structuredAggregationQuery": { "$ref": "StructuredAggregationQuery", "description": "An aggregation query." @@ -3243,6 +3343,10 @@ "format": "google-datetime", "type": "string" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for this request." +}, "structuredQuery": { "$ref": "StructuredQuery", "description": "A structured query." @@ -3691,6 +3795,10 @@ "description": "Labels associated with this write request.", "type": "object" }, +"requestOptions": { +"$ref": "RequestOptions", +"description": "Optional. The request options for the request." +}, "streamId": { "description": "The ID of the write stream to resume. This may only be set in the first message. When left empty, a new write stream will be created.", "type": "string" From 993aadc6dc3096ec6540aa393e85ec3b58cb46e2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:58 +0000 Subject: [PATCH 34/50] feat(gkebackup): update the api #### gkebackup:v1 The following keys were added: - schemas.BDRBackupRestoreJobLog.properties.storageTier.type (Total Keys: 1) --- .../discovery_cache/documents/gkebackup.v1.json | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 8dbf756b41..e12ef2d03b 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -2560,7 +2560,7 @@ } } }, -"revision": "20260608", +"revision": "20260624", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2697,7 +2697,7 @@ "type": "object" }, "BDRBackupRestoreJobLog": { -"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 25", +"description": "Log entry for Backup and Restore Job for resources using BackupPlan based protection. Next Id: 26", "id": "BDRBackupRestoreJobLog", "properties": { "backupConsistencyTime": { @@ -2799,6 +2799,10 @@ "format": "google-datetime", "type": "string" }, +"storageTier": { +"description": "The storage tier associated with the backup.", +"type": "string" +}, "targetResourceType": { "description": "The target resource type for restore jobs.", "type": "string" From b65185874966e95cde6c171fc6769a0094f7cf8c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:59 +0000 Subject: [PATCH 35/50] feat(health): update the api #### health:v4 The following keys were added: - resources.shl.resources.m.methods.getShlManifest (Total Keys: 10) - resources.shl.resources.r.methods.get (Total Keys: 12) - schemas.HttpBody (Total Keys: 8) - schemas.ManifestParams (Total Keys: 6) --- docs/dyn/health_v4.html | 5 + docs/dyn/health_v4.projects.subscribers.html | 6 +- docs/dyn/health_v4.shl.html | 96 +++++++ docs/dyn/health_v4.shl.m.html | 123 ++++++++ docs/dyn/health_v4.shl.r.html | 115 ++++++++ .../health_v4.users.dataTypes.dataPoints.html | 262 +++++++++--------- .../discovery_cache/documents/health.v4.json | 147 ++++++++-- 7 files changed, 602 insertions(+), 152 deletions(-) create mode 100644 docs/dyn/health_v4.shl.html create mode 100644 docs/dyn/health_v4.shl.m.html create mode 100644 docs/dyn/health_v4.shl.r.html diff --git a/docs/dyn/health_v4.html b/docs/dyn/health_v4.html index 4cd1e75e7f..71842e7582 100644 --- a/docs/dyn/health_v4.html +++ b/docs/dyn/health_v4.html @@ -79,6 +79,11 @@

Instance Methods

Returns the projects Resource.

+

+ shl() +

+

Returns the shl Resource.

+

users()

diff --git a/docs/dyn/health_v4.projects.subscribers.html b/docs/dyn/health_v4.projects.subscribers.html index 1b16a4e0d8..bcb30d0f7d 100644 --- a/docs/dyn/health_v4.projects.subscribers.html +++ b/docs/dyn/health_v4.projects.subscribers.html @@ -113,7 +113,7 @@

Method Details

The object takes the form of: { # Payload for creating a subscriber. - "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for the subscriber endpoint. The `secret` within this message is crucial for endpoint verification and for securing webhook notifications. "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. "secretSet": True or False, # Output only. Whether the secret is set. }, @@ -215,7 +215,7 @@

Method Details

"subscribers": [ # Subscribers from the specified project. { # -- Resource Messages -- A subscriber receives notifications from Google Health API. "createTime": "A String", # Output only. The time at which the subscriber was created. - "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. "secretSet": True or False, # Output only. Whether the secret is set. }, @@ -262,7 +262,7 @@

Method Details

{ # -- Resource Messages -- A subscriber receives notifications from Google Health API. "createTime": "A String", # Output only. The time at which the subscriber was created. - "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. + "endpointAuthorization": { # Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API. # Required. Authorization mechanism for a subscriber endpoint. This is required to ensure the endpoint can be verified. "secret": "A String", # Required. Input only. Provides a client-provided secret that will be sent with each notification to the subscriber endpoint using the "Authorization" header. The value must include the authorization scheme, e.g., "Bearer " or "Basic ", as it will be used as the full Authorization header value. This secret is used by the API to test the endpoint during `CreateSubscriber` and `UpdateSubscriber` calls, and will be sent in the `Authorization` header for all subsequent webhook notifications to this endpoint. "secretSet": True or False, # Output only. Whether the secret is set. }, diff --git a/docs/dyn/health_v4.shl.html b/docs/dyn/health_v4.shl.html new file mode 100644 index 0000000000..98256b4c4b --- /dev/null +++ b/docs/dyn/health_v4.shl.html @@ -0,0 +1,96 @@ + + + +

Google Health API . shl

+

Instance Methods

+

+ m() +

+

Returns the m Resource.

+ +

+ r() +

+

Returns the r Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.shl.m.html b/docs/dyn/health_v4.shl.m.html new file mode 100644 index 0000000000..cc00d73a20 --- /dev/null +++ b/docs/dyn/health_v4.shl.m.html @@ -0,0 +1,123 @@ + + + +

Google Health API . shl . m

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getShlManifest(externalShlId, body=None, x__xgafv=None)

+

Forward a manifest request for a given SHL

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getShlManifest(externalShlId, body=None, x__xgafv=None) +
Forward a manifest request for a given SHL
+
+Args:
+  externalShlId: string, Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents the POST body contained in a GetShlManifestRequest This message is nested to represent that See https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-link-manifest-request
+  "embeddedLengthMax": 42, # Optional. Integer upper bound on the length of embedded payloads
+  "passcode": "A String", # Optional.
+  "recipient": "A String", # Required. A string describing the recipient (e.g.,the name of an organization or person) suitable for display to the Receiving User
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.shl.r.html b/docs/dyn/health_v4.shl.r.html new file mode 100644 index 0000000000..148047f774 --- /dev/null +++ b/docs/dyn/health_v4.shl.r.html @@ -0,0 +1,115 @@ + + + +

Google Health API . shl . r

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(externalShlId, resourceToken, x__xgafv=None)

+

Forward a resource request for a given SHL

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(externalShlId, resourceToken, x__xgafv=None) +
Forward a resource request for a given SHL
+
+Args:
+  externalShlId: string, Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q (required)
+  resourceToken: string, Required. Encoded, encrypted message containing resource access details (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index 7c1844f569..642c1b65e1 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -827,28 +827,28 @@

Method Details

"description": "A String", # Optional. The description of the food. "displayName": "A String", # Required. The display name of the food. "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. "mealType": "A String", # Optional. The meal type associated with this food. "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -863,11 +863,11 @@

Method Details

}, ], "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -1075,18 +1075,18 @@

Method Details

}, }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. - "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. - "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "food": "A String", # Required. Represents the food ID. - "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead. + "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged. "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -1118,27 +1118,27 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. - "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`. + "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, ], - "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. - "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food. + "amount": 3.14, # Optional. The number of servings. "foodMeasurementUnit": "A String", # Required. Food measurement unit "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). }, - "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -2427,28 +2427,28 @@

Method Details

"description": "A String", # Optional. The description of the food. "displayName": "A String", # Required. The display name of the food. "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. "mealType": "A String", # Optional. The meal type associated with this food. "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -2463,11 +2463,11 @@

Method Details

}, ], "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -2675,18 +2675,18 @@

Method Details

}, }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. - "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. - "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "food": "A String", # Required. Represents the food ID. - "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead. + "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged. "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -2718,27 +2718,27 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. - "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`. + "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, ], - "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. - "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food. + "amount": 3.14, # Optional. The number of servings. "foodMeasurementUnit": "A String", # Required. Food measurement unit "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). }, - "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -3754,28 +3754,28 @@

Method Details

"description": "A String", # Optional. The description of the food. "displayName": "A String", # Required. The display name of the food. "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. "mealType": "A String", # Optional. The meal type associated with this food. "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -3790,11 +3790,11 @@

Method Details

}, ], "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -4002,18 +4002,18 @@

Method Details

}, }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. - "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. - "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "food": "A String", # Required. Represents the food ID. - "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead. + "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged. "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -4045,27 +4045,27 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. - "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`. + "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, ], - "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. - "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food. + "amount": 3.14, # Optional. The number of servings. "foodMeasurementUnit": "A String", # Required. Food measurement unit "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). }, - "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -5088,28 +5088,28 @@

Method Details

"description": "A String", # Optional. The description of the food. "displayName": "A String", # Required. The display name of the food. "energyAvg": { # Represents the energy quantity. # Optional. Value representing the average energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMax": { # Represents the energy quantity. # Optional. Value representing the maximum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "energyMin": { # Represents the energy quantity. # Optional. Value representing the minimum energy of the food for the default serving. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "languageCode": "A String", # Optional. The language code where the food is available in format xx-XX. Supported values are defined in Settings.food_language_code. "mealType": "A String", # Optional. The meal type associated with this food. "nutrients": [ # Optional. Value representing the nutrients of the food for the default serving. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -5124,11 +5124,11 @@

Method Details

}, ], "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the food for the default serving. - "grams": 3.14, # Required. Value representing the weight in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -5336,18 +5336,18 @@

Method Details

}, }, "name": "A String", # Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. - "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Optional. Data for points in the `nutrition-log` session data type collection. - "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Optional. Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "food": "A String", # Required. Represents the food ID. - "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead. + "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged. "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -5379,27 +5379,27 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. - "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`. + "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, ], - "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. - "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food. + "amount": 3.14, # Optional. The number of servings. "foodMeasurementUnit": "A String", # Required. Food measurement unit "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). }, - "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, @@ -6472,18 +6472,18 @@

Method Details

"startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, }, - "nutritionLog": { # Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable. # Data for points in the `nutrition-log` session data type collection. - "energy": { # Represents the energy quantity. # Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "nutritionLog": { # Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable. # Data for points in the `nutrition-log` session data type collection. + "energy": { # Represents the energy quantity. # Optional. The total energy of the food, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "energyFromFat": { # Represents the energy quantity. # Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "kcal": 3.14, # Required. Value representing the energy in kilocalories. + "energyFromFat": { # Represents the energy quantity. # Optional. The energy from fat, measured in kilocalories (`kcal`). + "kcal": 3.14, # Required. The energy value in kilocalories. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "food": "A String", # Required. Represents the food ID. - "foodDisplayName": "A String", # Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed interval. + "food": "A String", # Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead. + "foodDisplayName": "A String", # The display name of the food. For identified food logs, this is populated automatically from the referenced food. + "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. The time window when the food was logged. "civilEndTime": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Output only. Session end time in civil time in the timezone the subject is in at the end of the session. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -6515,27 +6515,27 @@

Method Details

"startTime": "A String", # Required. The start time of the observed session. "startUtcOffset": "A String", # Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC). }, - "mealType": "A String", # Optional. Value representing the meal type of the nutrition log. - "nutrients": [ # Optional. Value representing the nutrients of the nutrition log. + "mealType": "A String", # Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`. + "nutrients": [ # Optional. An array of individual nutrient values for the nutrition log. { # Represents the quantity of a nutrient. - "nutrient": "A String", # Required. Value representing the nutrient. - "quantity": { # Represents the weight quantity. # Required. Value representing the quantity of the nutrient. - "grams": 3.14, # Required. Value representing the weight in grams. + "nutrient": "A String", # Required. The nutrient type. + "quantity": { # Represents the weight quantity. # Required. The quantity of the nutrient, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, ], - "serving": { # Represents different properties and information about the serving of a specific food. # Optional. Value representing the nutrition log serving. - "amount": 3.14, # Optional. Amount of food consumed, fractional values are supported. + "serving": { # Represents different properties and information about the serving of a specific food. # Optional. The serving information for the logged food. + "amount": 3.14, # Optional. The number of servings. "foodMeasurementUnit": "A String", # Required. Food measurement unit "foodMeasurementUnitDisplayName": "A String", # Output only. Legacy measurement unit for serving size in singular form (e.g. "piece", "gram"). }, - "totalCarbohydrate": { # Represents the weight quantity. # Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalCarbohydrate": { # Represents the weight quantity. # Optional. The total carbohydrate content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, - "totalFat": { # Represents the weight quantity. # Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually. - "grams": 3.14, # Required. Value representing the weight in grams. + "totalFat": { # Represents the weight quantity. # Optional. The total fat content, measured in grams. + "grams": 3.14, # Required. The weight value in grams. "userProvidedUnit": "A String", # Optional. Value representing the user provided unit. }, }, diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index d720b472b0..3f725202d7 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -430,6 +430,70 @@ } } }, +"shl": { +"resources": { +"m": { +"methods": { +"getShlManifest": { +"description": "Forward a manifest request for a given SHL", +"flatPath": "v4/shl/m/{externalShlId}", +"httpMethod": "POST", +"id": "health.shl.m.getShlManifest", +"parameterOrder": [ +"externalShlId" +], +"parameters": { +"externalShlId": { +"description": "Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/shl/m/{externalShlId}", +"request": { +"$ref": "ManifestParams" +}, +"response": { +"$ref": "HttpBody" +} +} +} +}, +"r": { +"methods": { +"get": { +"description": "Forward a resource request for a given SHL", +"flatPath": "v4/shl/r/{externalShlId}/{resourceToken}", +"httpMethod": "GET", +"id": "health.shl.r.get", +"parameterOrder": [ +"externalShlId", +"resourceToken" +], +"parameters": { +"externalShlId": { +"description": "Required. External ID mapping to a ShlSharedLinkCapabilityToken object See https://docs.google.com/document/d/1Pch20pxJHRbsaMxp0EYgs3ZU0Gu7QTUznk8LhvbQvfY/edit?tab=t.0#heading=h.17wg41voij6q", +"location": "path", +"required": true, +"type": "string" +}, +"resourceToken": { +"description": "Required. Encoded, encrypted message containing resource access details", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "v4/shl/r/{externalShlId}/{resourceToken}", +"response": { +"$ref": "HttpBody" +} +} +} +} +} +}, "users": { "methods": { "getIdentity": { @@ -996,7 +1060,7 @@ } } }, -"revision": "20260629", +"revision": "20260709", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -2518,7 +2582,7 @@ "type": "object" }, "EndpointAuthorization": { -"description": "Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `X-HEALTHAPI-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.", +"description": "Authorization mechanism for a subscriber endpoint. For all requests sent by the Webhooks service, the JSON payload is cryptographically signed. The signature is delivered in the `GOOGLE-HEALTH-API-SIGNATURE` HTTP header. This is an ECDSA (NIST P256) signature of the JSON payload. Clients must verify this signature using Google Health API's public key to confirm the payload was sent by the Health API.", "id": "EndpointAuthorization", "properties": { "secret": { @@ -2538,7 +2602,7 @@ "id": "EnergyQuantity", "properties": { "kcal": { -"description": "Required. Value representing the energy in kilocalories.", +"description": "Required. The energy value in kilocalories.", "format": "double", "type": "number" }, @@ -3515,6 +3579,33 @@ }, "type": "object" }, +"HttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "HttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, "HttpHeader": { "description": "Represents an HTTP header.", "id": "HttpHeader", @@ -3747,6 +3838,26 @@ }, "type": "object" }, +"ManifestParams": { +"description": "Represents the POST body contained in a GetShlManifestRequest This message is nested to represent that See https://build.fhir.org/ig/HL7/smart-health-cards-and-links/links-specification.html#smart-health-link-manifest-request", +"id": "ManifestParams", +"properties": { +"embeddedLengthMax": { +"description": "Optional. Integer upper bound on the length of embedded payloads", +"format": "int32", +"type": "integer" +}, +"passcode": { +"description": "Optional. ", +"type": "string" +}, +"recipient": { +"description": "Required. A string describing the recipient (e.g.,the name of an organization or person) suitable for display to the Receiving User", +"type": "string" +} +}, +"type": "object" +}, "MedicalDeviceInfo": { "description": "Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).", "id": "MedicalDeviceInfo", @@ -3881,7 +3992,7 @@ "id": "NutrientQuantity", "properties": { "nutrient": { -"description": "Required. Value representing the nutrient.", +"description": "Required. The nutrient type.", "enum": [ "NUTRIENT_UNSPECIFIED", "BIOTIN", @@ -3970,7 +4081,7 @@ }, "quantity": { "$ref": "WeightQuantity", -"description": "Required. Value representing the quantity of the nutrient." +"description": "Required. The quantity of the nutrient, measured in grams." } }, "type": "object" @@ -4075,31 +4186,31 @@ "type": "object" }, "NutritionLog": { -"description": "Holds information about a user logged food. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not be editable.", +"description": "Holds information about food logged by a user. There are two ways of creating a nutrition log based on the food type: 1. Identified food: Using the food field, which is a reference to a Food resource. In this case fields `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat`, `food_display_name` will be populated based on the referenced food. 2. Anonymous food: Using the `food_display_name` field and setting the `nutrients`, `energy`, `energy_from_fat`, `total_carbohydrate`, `total_fat` fields manually. The identified food is preferred over the anonymous food. Nutrition logs created from anonymous food are not editable.", "id": "NutritionLog", "properties": { "energy": { "$ref": "EnergyQuantity", -"description": "Optional. Value representing the energy of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +"description": "Optional. The total energy of the food, measured in kilocalories (`kcal`)." }, "energyFromFat": { "$ref": "EnergyQuantity", -"description": "Optional. Value representing the energy from fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +"description": "Optional. The energy from fat, measured in kilocalories (`kcal`)." }, "food": { -"description": "Required. Represents the food ID.", +"description": "Optional. The resource name of the Food item. Required when creating a nutrition log from an identified food. For anonymous food logs, use the `food_display_name` field instead.", "type": "string" }, "foodDisplayName": { -"description": "Value representing the display name of the food. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually.", +"description": "The display name of the food. For identified food logs, this is populated automatically from the referenced food.", "type": "string" }, "interval": { "$ref": "SessionTimeInterval", -"description": "Required. Observed interval." +"description": "Required. The time window when the food was logged." }, "mealType": { -"description": "Optional. Value representing the meal type of the nutrition log.", +"description": "Optional. The meal category. One of `BREAKFAST`, `LUNCH`, `DINNER`, or `SNACK`.", "enum": [ "MEAL_TYPE_UNSPECIFIED", "BEFORE_BREAKFAST", @@ -4127,7 +4238,7 @@ "type": "string" }, "nutrients": { -"description": "Optional. Value representing the nutrients of the nutrition log.", +"description": "Optional. An array of individual nutrient values for the nutrition log.", "items": { "$ref": "NutrientQuantity" }, @@ -4135,15 +4246,15 @@ }, "serving": { "$ref": "Serving", -"description": "Optional. Value representing the nutrition log serving." +"description": "Optional. The serving information for the logged food." }, "totalCarbohydrate": { "$ref": "WeightQuantity", -"description": "Optional. Value representing the total carbohydrate of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +"description": "Optional. The total carbohydrate content, measured in grams." }, "totalFat": { "$ref": "WeightQuantity", -"description": "Optional. Value representing the total fat of the nutrition log. For nutrition logs created from an identified food, this field will be populated based on the referenced food. For anonymous food, this field will be populated manually." +"description": "Optional. The total fat content, measured in grams." } }, "type": "object" @@ -4864,7 +4975,7 @@ "id": "Serving", "properties": { "amount": { -"description": "Optional. Amount of food consumed, fractional values are supported.", +"description": "Optional. The number of servings.", "format": "double", "type": "number" }, @@ -5911,7 +6022,7 @@ "id": "WeightQuantity", "properties": { "grams": { -"description": "Required. Value representing the weight in grams.", +"description": "Required. The weight value in grams.", "format": "double", "type": "number" }, From 0024b6810767a910fe06e85f6a312f056f34fc60 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:41:59 +0000 Subject: [PATCH 36/50] feat(iamcredentials): update the api #### iamcredentials:v1 The following keys were deleted: - endpoints (Total Keys: 1) --- .../documents/iamcredentials.v1.json | 34 +------------------ 1 file changed, 1 insertion(+), 33 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index ca5e4e0051..2ee43fe3e9 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -15,38 +15,6 @@ "description": "Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API. ", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", -"endpoints": [ -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.asia-east1.rep.googleapis.com/", -"location": "asia-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.europe-west1.rep.googleapis.com/", -"location": "europe-west1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.us-central1.rep.googleapis.com/", -"location": "us-central1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.us-east1.rep.googleapis.com/", -"location": "us-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.us-east7.rep.googleapis.com/", -"location": "us-east7" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://iamcredentials.us-west1.rep.googleapis.com/", -"location": "us-west1" -} -], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -340,7 +308,7 @@ } } }, -"revision": "20260604", +"revision": "20260630", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { From 25da1e5d16fb91d4d518e90ab04a9d4fdfa7abf9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:00 +0000 Subject: [PATCH 37/50] feat(kmsinventory): update the api #### kmsinventory:v1 The following keys were added: - schemas.GoogleCloudKmsV1CryptoKeyVersion.properties.hsmTrusted (Total Keys: 2) - schemas.GoogleCloudKmsV1CryptoKeyVersion.properties.trustedWrappingEnabled.type (Total Keys: 1) - schemas.GoogleCloudKmsV1ExternalProtectionLevelOptions.properties.ekmConnectionBackendOverride.type (Total Keys: 1) --- .../kmsinventory_v1.projects.cryptoKeys.html | 7 +++- .../documents/kmsinventory.v1.json | 37 ++++++++++++++----- 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html b/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html index c062f1cc88..64818985ef 100644 --- a/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html +++ b/docs/dyn/kmsinventory_v1.projects.cryptoKeys.html @@ -144,11 +144,13 @@

Method Details

"destroyTime": "A String", # Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. "externalDestructionFailureReason": "A String", # Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. "externalProtectionLevelOptions": { # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. # ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. - "ekmConnectionKeyPath": "A String", # The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. - "externalKeyUri": "A String", # The URI for an external resource that this CryptoKeyVersion represents. + "ekmConnectionBackendOverride": "A String", # Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`. + "ekmConnectionKeyPath": "A String", # Optional. The path to the external key material on the EKM when using EkmConnection e.g., "v0/my/key". Set this field instead of external_key_uri when using an EkmConnection. + "externalKeyUri": "A String", # Optional. The URI for an external resource that this CryptoKeyVersion represents. }, "generateTime": "A String", # Output only. The time this CryptoKeyVersion's key material was generated. "generationFailureReason": "A String", # Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. + "hsmTrusted": True or False, # Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT. "importFailureReason": "A String", # Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. "importJob": "A String", # Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. "importTime": "A String", # Output only. The time at which this CryptoKeyVersion's key material was most recently imported. @@ -156,6 +158,7 @@

Method Details

"protectionLevel": "A String", # Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. "reimportEligible": True or False, # Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. "state": "A String", # The current state of the CryptoKeyVersion. + "trustedWrappingEnabled": True or False, # Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion. }, "purpose": "A String", # Immutable. The immutable purpose of this CryptoKey. "rotationPeriod": "A String", # next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index c3b089785f..abcf80fe51 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -306,7 +306,7 @@ } } }, -"revision": "20260308", +"revision": "20260705", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { @@ -537,7 +537,8 @@ "ASYMMETRIC_DECRYPT", "RAW_ENCRYPT_DECRYPT", "MAC", -"KEY_ENCAPSULATION" +"KEY_ENCAPSULATION", +"AES_WRAPPING" ], "enumDescriptions": [ "Not specified.", @@ -546,7 +547,8 @@ "CryptoKeys with this purpose may be used with AsymmetricDecrypt and GetPublicKey.", "CryptoKeys with this purpose may be used with RawEncrypt and RawDecrypt. This purpose is meant to be used for interoperable symmetric encryption and does not support automatic CryptoKey rotation.", "CryptoKeys with this purpose may be used with MacSign.", -"CryptoKeys with this purpose may be used with GetPublicKey and Decapsulate." +"CryptoKeys with this purpose may be used with GetPublicKey and Decapsulate.", +"CryptoKeys with this purpose may be used for AES key" ], "type": "string" }, @@ -615,7 +617,8 @@ "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -664,7 +667,8 @@ "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "readOnly": true, "type": "string" @@ -712,6 +716,11 @@ "readOnly": true, "type": "string" }, +"hsmTrusted": { +"description": "Output only. Field indicating that the key wrapping key is trusted. This field is only valid for key purpose AES_256_WRAPPING, and protection level HSM_SINGLE_TENANT.", +"readOnly": true, +"type": "boolean" +}, "importFailureReason": { "description": "Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED.", "readOnly": true, @@ -788,6 +797,10 @@ "This version was destroyed, and it may not be used or enabled again. However, Cloud KMS could not confirm that the corresponding key material residing in an external key manager was destroyed. Additional details can be found in CryptoKeyVersion.external_destruction_failure_reason." ], "type": "string" +}, +"trustedWrappingEnabled": { +"description": "Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.", +"type": "boolean" } }, "type": "object" @@ -845,7 +858,8 @@ "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256", "PQ_SIGN_ML_DSA_44_EXTERNAL_MU", "PQ_SIGN_ML_DSA_65_EXTERNAL_MU", -"PQ_SIGN_ML_DSA_87_EXTERNAL_MU" +"PQ_SIGN_ML_DSA_87_EXTERNAL_MU", +"AES_256_KWP" ], "enumDescriptions": [ "Not specified.", @@ -894,7 +908,8 @@ "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.", "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.", -"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives." +"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.", +"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING." ], "type": "string" }, @@ -925,12 +940,16 @@ "description": "ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels.", "id": "GoogleCloudKmsV1ExternalProtectionLevelOptions", "properties": { +"ekmConnectionBackendOverride": { +"description": "Optional. The resource name of the backend environment where the key material of CryptoKeyVersions is associated with. Setting this field overrides the CryptoKeyBackend. This field may be set when CryptoKeyVersions is set to EXTERNAL_VPC. Format: `projects/*/locations/*/ekmConnections/*`.", +"type": "string" +}, "ekmConnectionKeyPath": { -"description": "The path to the external key material on the EKM when using EkmConnection e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an EkmConnection.", +"description": "Optional. The path to the external key material on the EKM when using EkmConnection e.g., \"v0/my/key\". Set this field instead of external_key_uri when using an EkmConnection.", "type": "string" }, "externalKeyUri": { -"description": "The URI for an external resource that this CryptoKeyVersion represents.", +"description": "Optional. The URI for an external resource that this CryptoKeyVersion represents.", "type": "string" } }, From c0c580f899589b92726ff8ef4be59cf2905c78db Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:00 +0000 Subject: [PATCH 38/50] fix(logging): update the api #### logging:v2 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/logging.v2.json | 27 +------------------ 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index aa637d272e..0ba18c73fb 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -250,31 +250,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://logging.europe-west15.rep.googleapis.com/", -"location": "europe-west15" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://logging.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://logging.us-central6.rep.googleapis.com/", -"location": "us-central6" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://logging.us-east7.rep.googleapis.com/", -"location": "us-east7" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://logging.us-west8.rep.googleapis.com/", -"location": "us-west8" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://logging.ca.rep.googleapis.com/", "location": "ca" }, @@ -9172,7 +9147,7 @@ } } }, -"revision": "20260610", +"revision": "20260706", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { From e0c0cf5e88dbfef767e0975af7a59e5c57521d3f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:01 +0000 Subject: [PATCH 39/50] feat(netapp): update the api #### netapp:v1 The following keys were added: - schemas.LocationMetadata.properties.flexPerformanceTier (Total Keys: 2) #### netapp:v1beta1 The following keys were added: - schemas.LocationMetadata.properties.flexPerformanceTier (Total Keys: 2) --- .../discovery_cache/documents/netapp.v1.json | 15 ++++++++++++++- .../discovery_cache/documents/netapp.v1beta1.json | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/netapp.v1.json b/googleapiclient/discovery_cache/documents/netapp.v1.json index 26c930df08..3a47ae16c1 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1.json @@ -2933,7 +2933,7 @@ } } }, -"revision": "20260518", +"revision": "20260628", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4572,6 +4572,19 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { +"flexPerformanceTier": { +"description": "Output only. Indicates the flex performance tier of this location.", +"enum": [ +"FLEX_PERFORMANCE_TIER_UNSPECIFIED", +"LIMITED" +], +"enumDescriptions": [ +"Unspecified flex performance tier.", +"Flex performance tier is limited." +], +"readOnly": true, +"type": "string" +}, "hasOntapProxy": { "description": "Output only. Indicates if the location has ONTAP Proxy support.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json index 8c9bca477c..ff432957c5 100644 --- a/googleapiclient/discovery_cache/documents/netapp.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/netapp.v1beta1.json @@ -3003,7 +3003,7 @@ } } }, -"revision": "20260621", +"revision": "20260628", "rootUrl": "https://netapp.googleapis.com/", "schemas": { "ActiveDirectory": { @@ -4663,6 +4663,19 @@ "description": "Metadata for a given google.cloud.location.Location.", "id": "LocationMetadata", "properties": { +"flexPerformanceTier": { +"description": "Output only. Indicates the flex performance tier of this location.", +"enum": [ +"FLEX_PERFORMANCE_TIER_UNSPECIFIED", +"LIMITED" +], +"enumDescriptions": [ +"Unspecified flex performance tier.", +"Flex performance tier is limited." +], +"readOnly": true, +"type": "string" +}, "hasOntapProxy": { "description": "Output only. Indicates if the location has ONTAP Proxy support.", "readOnly": true, From 5f96d4239a78dcac24f43a7ee9f38bea80238283 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:02 +0000 Subject: [PATCH 40/50] feat(networkservices): update the api #### networkservices:v1 The following keys were deleted: - schemas.AgentGatewayNetworkConfigEgress.properties.trustConfig.$ref (Total Keys: 1) - schemas.AgentGatewayNetworkConfigEgressTrustConfig (Total Keys: 4) #### networkservices:v1beta1 The following keys were deleted: - schemas.AgentGatewayNetworkConfigEgress.properties.trustConfig.$ref (Total Keys: 1) - schemas.AgentGatewayNetworkConfigEgressTrustConfig (Total Keys: 4) --- ...s_v1.projects.locations.agentGateways.html | 28 +++---------------- ...eta1.projects.locations.agentGateways.html | 28 +++---------------- .../documents/networkservices.v1.json | 22 ++------------- .../documents/networkservices.v1beta1.json | 22 ++------------- 4 files changed, 12 insertions(+), 88 deletions(-) diff --git a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html index 68bdd6338f..4faa4091ca 100644 --- a/docs/dyn/networkservices_v1.projects.locations.agentGateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.agentGateways.html @@ -138,17 +138,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -265,17 +260,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -332,17 +322,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -409,17 +394,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html index c9218d28b3..ebbfd1f464 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.agentGateways.html @@ -138,17 +138,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -265,17 +260,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -332,17 +322,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. @@ -409,17 +394,12 @@

Method Details

}, "egress": { # Configuration for Egress # Optional. Optional PSC-Interface network attachment for connectivity to your private VPCs network. "networkAttachment": "A String", # Optional. The URI of the Network Attachment resource. - "trustConfig": { # TrustConfig defines the trust configuration for egress. # Optional. TrustConfig defines the trust configuration for egress. - "pemCertificates": [ # Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections. - "A String", - ], - }, }, }, "protocols": [ # Optional. Deprecated. "A String", ], - "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/ + "registries": [ # Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/` "A String", ], "selfManaged": { # Configuration for Self Managed deployment mode. Attach to existing Application Load Balancers or Secure Web Proxies. # Optional. Attach to existing Application Load Balancers or Secure Web Proxies. diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index c1548b6709..abef7ee6bb 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -3732,7 +3732,7 @@ } } }, -"revision": "20260610", +"revision": "20260626", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentGateway": { @@ -3794,7 +3794,7 @@ "type": "array" }, "registries": { -"description": "Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/", +"description": "Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/`", "items": { "type": "string" }, @@ -3903,24 +3903,6 @@ "networkAttachment": { "description": "Optional. The URI of the Network Attachment resource.", "type": "string" -}, -"trustConfig": { -"$ref": "AgentGatewayNetworkConfigEgressTrustConfig", -"description": "Optional. TrustConfig defines the trust configuration for egress." -} -}, -"type": "object" -}, -"AgentGatewayNetworkConfigEgressTrustConfig": { -"description": "TrustConfig defines the trust configuration for egress.", -"id": "AgentGatewayNetworkConfigEgressTrustConfig", -"properties": { -"pemCertificates": { -"description": "Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 301ea4f604..0bd254b6bc 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -3277,7 +3277,7 @@ } } }, -"revision": "20260610", +"revision": "20260626", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentGateway": { @@ -3339,7 +3339,7 @@ "type": "array" }, "registries": { -"description": "Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/", +"description": "Optional. A list of Agent registries containing the agents, MCP servers and tools governed by the Agent Gateway. Note: Currently limited to project-scoped registries Must be of format `//agentregistry.googleapis.com/projects/{project}/locations/{location}/`", "items": { "type": "string" }, @@ -3448,24 +3448,6 @@ "networkAttachment": { "description": "Optional. The URI of the Network Attachment resource.", "type": "string" -}, -"trustConfig": { -"$ref": "AgentGatewayNetworkConfigEgressTrustConfig", -"description": "Optional. TrustConfig defines the trust configuration for egress." -} -}, -"type": "object" -}, -"AgentGatewayNetworkConfigEgressTrustConfig": { -"description": "TrustConfig defines the trust configuration for egress.", -"id": "AgentGatewayNetworkConfigEgressTrustConfig", -"properties": { -"pemCertificates": { -"description": "Required. PEM encoded root certificates used to validate the identity of the upstream servers/destinations during egress connections.", -"items": { -"type": "string" -}, -"type": "array" } }, "type": "object" From e87e6bfc529290c67f14b2c9e67ab2039ea00ab5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:02 +0000 Subject: [PATCH 41/50] fix(observability): update the api #### observability:v1 The following keys were changed: - endpoints (Total Keys: 1) --- .../discovery_cache/documents/observability.v1.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/observability.v1.json b/googleapiclient/discovery_cache/documents/observability.v1.json index 38663811b4..3946c52493 100644 --- a/googleapiclient/discovery_cache/documents/observability.v1.json +++ b/googleapiclient/discovery_cache/documents/observability.v1.json @@ -198,6 +198,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://observability.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://observability.me-central2.rep.googleapis.com/", "location": "me-central2" }, @@ -1721,7 +1726,7 @@ } } }, -"revision": "20260611", +"revision": "20260630", "rootUrl": "https://observability.googleapis.com/", "schemas": { "Bucket": { From b4e4da9cda59daea46a6c3b8e091abcd9aeec884 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:03 +0000 Subject: [PATCH 42/50] feat(parametermanager): update the api #### parametermanager:v1 The following keys were added: - resources.projects.resources.locations.resources.templates.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.templates.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.templates.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.templates.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.templates.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.templates.resources.versions.methods.create (Total Keys: 16) - resources.projects.resources.locations.resources.templates.resources.versions.methods.delete (Total Keys: 13) - resources.projects.resources.locations.resources.templates.resources.versions.methods.get (Total Keys: 13) - resources.projects.resources.locations.resources.templates.resources.versions.methods.list (Total Keys: 20) - resources.projects.resources.locations.resources.templates.resources.versions.methods.patch (Total Keys: 17) - resources.projects.resources.locations.resources.templates.resources.versions.methods.render (Total Keys: 13) - schemas.ListTemplateVersionsResponse (Total Keys: 7) - schemas.ListTemplatesResponse (Total Keys: 7) - schemas.RenderTemplateVersionResponse (Total Keys: 11) - schemas.Template (Total Keys: 27) The following keys were changed: - endpoints (Total Keys: 1) --- ...arametermanager_v1.projects.locations.html | 5 + ...nager_v1.projects.locations.templates.html | 284 ++++++++ ...projects.locations.templates.versions.html | 313 +++++++++ .../documents/parametermanager.v1.json | 606 +++++++++++++++++- 4 files changed, 1192 insertions(+), 16 deletions(-) create mode 100644 docs/dyn/parametermanager_v1.projects.locations.templates.html create mode 100644 docs/dyn/parametermanager_v1.projects.locations.templates.versions.html diff --git a/docs/dyn/parametermanager_v1.projects.locations.html b/docs/dyn/parametermanager_v1.projects.locations.html index 19860f3d6d..63518a50cb 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.html +++ b/docs/dyn/parametermanager_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the parameters Resource.

+

+ templates() +

+

Returns the templates Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/parametermanager_v1.projects.locations.templates.html b/docs/dyn/parametermanager_v1.projects.locations.templates.html new file mode 100644 index 0000000000..d84959fd18 --- /dev/null +++ b/docs/dyn/parametermanager_v1.projects.locations.templates.html @@ -0,0 +1,284 @@ + + + +

Parameter Manager API . projects . locations . templates

+

Instance Methods

+

+ versions() +

+

Returns the versions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, requestId=None, templateId=None, x__xgafv=None)

+

Creates a new Template in a given project and location.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes a single Template.

+

+ get(name, x__xgafv=None)

+

Gets details of a single Template.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists Templates in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Updates a single Template.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, templateId=None, x__xgafv=None) +
Creates a new Template in a given project and location.
+
+Args:
+  parent: string, Required. Value for parent in the format `projects/*/locations/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing Template resource
+  "createTime": "A String", # Output only. Create time stamp
+  "format": "A String", # Optional. Specifies the format of a Template.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  templateId: string, Required. Id of the Template resource
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Template resource
+  "createTime": "A String", # Output only. Create time stamp
+  "format": "A String", # Optional. Specifies the format of a Template.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single Template.
+
+Args:
+  name: string, Required. Name of the resource in the format `projects/*/locations/*/templates/*`. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets details of a single Template.
+
+Args:
+  name: string, Required. Name of the resource in the format `projects/*/locations/*/templates/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Template resource
+  "createTime": "A String", # Output only. Create time stamp
+  "format": "A String", # Optional. Specifies the format of a Template.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Templates in a given project and location.
+
+Args:
+  parent: string, Required. Parent value for ListTemplatesRequest in the format `projects/*/locations/*`. (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A page token, received from a previous `ListTemplates` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTemplates` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing Templates
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "templates": [ # The list of Templates
+    { # Message describing Template resource
+      "createTime": "A String", # Output only. Create time stamp
+      "format": "A String", # Optional. Specifies the format of a Template.
+      "labels": { # Optional. Labels as key value pairs
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+      "updateTime": "A String", # Output only. Update time stamp
+    },
+  ],
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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, requestId=None, updateMask=None, x__xgafv=None) +
Updates a single Template.
+
+Args:
+  name: string, Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing Template resource
+  "createTime": "A String", # Output only. Create time stamp
+  "format": "A String", # Optional. Specifies the format of a Template.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Template resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing Template resource
+  "createTime": "A String", # Output only. Create time stamp
+  "format": "A String", # Optional. Specifies the format of a Template.
+  "labels": { # Optional. Labels as key value pairs
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html b/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html new file mode 100644 index 0000000000..59b845367b --- /dev/null +++ b/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html @@ -0,0 +1,313 @@ + + + +

Parameter Manager API . projects . locations . templates . versions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, requestId=None, templateVersionId=None, x__xgafv=None)

+

Creates a new TemplateVersion in a given project, location, and template.

+

+ delete(name, requestId=None, x__xgafv=None)

+

Deletes a single TemplateVersion.

+

+ get(name, view=None, x__xgafv=None)

+

Gets details of a single TemplateVersion.

+

+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists TemplateVersions in a given project, location, and template.

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)

+

Updates a single TemplateVersion.

+

+ render(name, parameterVersion=None, x__xgafv=None)

+

Gets rendered version of a TemplateVersion.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, templateVersionId=None, x__xgafv=None) +
Creates a new TemplateVersion in a given project, location, and template.
+
+Args:
+  parent: string, Required. Value for parent in the format `projects/*/locations/*/templates/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing TemplateVersion resource
+  "createTime": "A String", # Output only. Create time stamp
+  "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+  "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  templateVersionId: string, Required. Id of the TemplateVersion resource
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing TemplateVersion resource
+  "createTime": "A String", # Output only. Create time stamp
+  "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+  "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ delete(name, requestId=None, x__xgafv=None) +
Deletes a single TemplateVersion.
+
+Args:
+  name: string, Required. Name of the resource in the format `projects/*/locations/*/templates/*/versions/*`. (required)
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets details of a single TemplateVersion.
+
+Args:
+  name: string, Required. Name of the resource in the format `projects/*/locations/*/templates/*/versions/*`. (required)
+  view: string, Optional. Specifies the view of the TemplateVersion to return. In the default FULL view, all metadata & payload associated with the TemplateVersion will be returned.
+    Allowed values
+      VIEW_UNSPECIFIED - The default / unset value. The API will default to the FULL view.
+      BASIC - Include only the metadata for the resource.
+      FULL - Include metadata & other relevant payload data as well. This is the default view.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing TemplateVersion resource
+  "createTime": "A String", # Output only. Create time stamp
+  "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+  "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists TemplateVersions in a given project, location, and template.
+
+Args:
+  parent: string, Required. Parent value for ListTemplateVersionsRequest in the format `projects/*/locations/*/templates/*`. (required)
+  filter: string, Optional. Filtering results
+  orderBy: string, Optional. Hint for how to order the results
+  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
+  pageToken: string, Optional. A page token, received from a previous `ListTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTemplateVersions` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing TemplateVersions
+  "nextPageToken": "A String", # A token identifying a page of results the server should return.
+  "templateVersions": [ # The list of TemplateVersions
+    { # Message describing TemplateVersion resource
+      "createTime": "A String", # Output only. Create time stamp
+      "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+      "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+      "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+        "data": "A String", # Required. bytes data for storing payload.
+      },
+      "updateTime": "A String", # Output only. Update time stamp
+    },
+  ],
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+}
+
+ +
+ 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, requestId=None, updateMask=None, x__xgafv=None) +
Updates a single TemplateVersion.
+
+Args:
+  name: string, Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message describing TemplateVersion resource
+  "createTime": "A String", # Output only. Create time stamp
+  "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+  "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+  requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the TemplateVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing TemplateVersion resource
+  "createTime": "A String", # Output only. Create time stamp
+  "disabled": True or False, # Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).
+  "name": "A String", # Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Required. Immutable. Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "updateTime": "A String", # Output only. Update time stamp
+}
+
+ +
+ render(name, parameterVersion=None, x__xgafv=None) +
Gets rendered version of a TemplateVersion.
+
+Args:
+  name: string, Required. Name of the resource (required)
+  parameterVersion: string, Required. Parameter version used to render the template version.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message describing RenderTemplateVersionResponse resource
+  "parameterVersion": "A String", # Output only. The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`.
+  "payload": { # Message for storing a TemplateVersion resource's payload data # Payload content of a TemplateVersion resource.
+    "data": "A String", # Required. bytes data for storing payload.
+  },
+  "renderedPayload": "A String", # Output only. Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version.
+  "templateFormat": "A String", # Output only. Format of the template version.
+  "templateVersion": "A String", # Resource identifier of a TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index ff30dc7bc6..aadac9ed23 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -48,16 +48,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-east7.rep.googleapis.com/", -"location": "us-east7" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.us-central2.rep.googleapis.com/", -"location": "us-central2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://parametermanager.us-east1.rep.googleapis.com/", "location": "us-east1" }, @@ -238,11 +228,6 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://parametermanager.europe-west15.rep.googleapis.com/", -"location": "europe-west15" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://parametermanager.us.rep.googleapis.com/", "location": "us" }, @@ -825,13 +810,424 @@ } } } +}, +"templates": { +"methods": { +"create": { +"description": "Creates a new Template in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", +"httpMethod": "POST", +"id": "parametermanager.projects.locations.templates.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"templateId": { +"description": "Required. Id of the Template resource", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/templates", +"request": { +"$ref": "Template" +}, +"response": { +"$ref": "Template" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single Template.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", +"httpMethod": "DELETE", +"id": "parametermanager.projects.locations.templates.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource in the format `projects/*/locations/*/templates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single Template.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", +"httpMethod": "GET", +"id": "parametermanager.projects.locations.templates.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource in the format `projects/*/locations/*/templates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Template" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists Templates in a given project and location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates", +"httpMethod": "GET", +"id": "parametermanager.projects.locations.templates.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"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" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListTemplates` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTemplates` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListTemplatesRequest in the format `projects/*/locations/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/templates", +"response": { +"$ref": "ListTemplatesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single Template.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", +"httpMethod": "PATCH", +"id": "parametermanager.projects.locations.templates.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the Template resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } +}, +"path": "v1/{+name}", +"request": { +"$ref": "Template" +}, +"response": { +"$ref": "Template" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } +}, +"resources": { +"versions": { +"methods": { +"create": { +"description": "Creates a new TemplateVersion in a given project, location, and template.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions", +"httpMethod": "POST", +"id": "parametermanager.projects.locations.templates.versions.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Value for parent in the format `projects/*/locations/*/templates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"templateVersionId": { +"description": "Required. Id of the TemplateVersion resource", +"location": "query", +"type": "string" } +}, +"path": "v1/{+parent}/versions", +"request": { +"$ref": "TemplateVersion" +}, +"response": { +"$ref": "TemplateVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single TemplateVersion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions/{versionsId}", +"httpMethod": "DELETE", +"id": "parametermanager.projects.locations.templates.versions.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource in the format `projects/*/locations/*/templates/*/versions/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" } +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single TemplateVersion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions/{versionsId}", +"httpMethod": "GET", +"id": "parametermanager.projects.locations.templates.versions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource in the format `projects/*/locations/*/templates/*/versions/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. Specifies the view of the TemplateVersion to return. In the default FULL view, all metadata & payload associated with the TemplateVersion will be returned.", +"enum": [ +"VIEW_UNSPECIFIED", +"BASIC", +"FULL" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the FULL view.", +"Include only the metadata for the resource.", +"Include metadata & other relevant payload data as well. This is the default view." +], +"location": "query", +"type": "string" } }, -"revision": "20260610", +"path": "v1/{+name}", +"response": { +"$ref": "TemplateVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists TemplateVersions in a given project, location, and template.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions", +"httpMethod": "GET", +"id": "parametermanager.projects.locations.templates.versions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results", +"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" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListTemplateVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTemplateVersions` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent value for ListTemplateVersionsRequest in the format `projects/*/locations/*/templates/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/versions", +"response": { +"$ref": "ListTemplateVersionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a single TemplateVersion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions/{versionsId}", +"httpMethod": "PATCH", +"id": "parametermanager.projects.locations.templates.versions.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. Field mask is used to specify the fields to be overwritten in the TemplateVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "TemplateVersion" +}, +"response": { +"$ref": "TemplateVersion" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"render": { +"description": "Gets rendered version of a TemplateVersion.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}/versions/{versionsId}:render", +"httpMethod": "GET", +"id": "parametermanager.projects.locations.templates.versions.render", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the resource", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+/versions/[^/]+$", +"required": true, +"type": "string" +}, +"parameterVersion": { +"description": "Required. Parameter version used to render the template version.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}:render", +"response": { +"$ref": "RenderTemplateVersionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +}, +"revision": "20260629", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { @@ -908,6 +1304,56 @@ }, "type": "object" }, +"ListTemplateVersionsResponse": { +"description": "Message for response to listing TemplateVersions", +"id": "ListTemplateVersionsResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"templateVersions": { +"description": "The list of TemplateVersions", +"items": { +"$ref": "TemplateVersion" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListTemplatesResponse": { +"description": "Message for response to listing Templates", +"id": "ListTemplatesResponse", +"properties": { +"nextPageToken": { +"description": "A token identifying a page of results the server should return.", +"type": "string" +}, +"templates": { +"description": "The list of Templates", +"items": { +"$ref": "Template" +}, +"type": "array" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1067,6 +1513,47 @@ }, "type": "object" }, +"RenderTemplateVersionResponse": { +"description": "Message describing RenderTemplateVersionResponse resource", +"id": "RenderTemplateVersionResponse", +"properties": { +"parameterVersion": { +"description": "Output only. The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`.", +"readOnly": true, +"type": "string" +}, +"payload": { +"$ref": "TemplateVersionPayload", +"description": "Payload content of a TemplateVersion resource." +}, +"renderedPayload": { +"description": "Output only. Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version.", +"format": "byte", +"readOnly": true, +"type": "string" +}, +"templateFormat": { +"description": "Output only. Format of the template version.", +"enum": [ +"TEMPLATE_FORMAT_UNSPECIFIED", +"TEMPLATE_FORMAT_YAML", +"TEMPLATE_FORMAT_JSON" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the YAML format.", +"YAML format.", +"JSON format." +], +"readOnly": true, +"type": "string" +}, +"templateVersion": { +"description": "Resource identifier of a TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.", +"type": "string" +} +}, +"type": "object" +}, "ResourcePolicyMember": { "description": "Output-only policy member strings of a Google Cloud resource's built-in identity.", "id": "ResourcePolicyMember", @@ -1083,6 +1570,93 @@ } }, "type": "object" +}, +"Template": { +"description": "Message describing Template resource", +"id": "Template", +"properties": { +"createTime": { +"description": "Output only. Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"format": { +"description": "Optional. Specifies the format of a Template.", +"enum": [ +"TEMPLATE_FORMAT_UNSPECIFIED", +"TEMPLATE_FORMAT_YAML", +"TEMPLATE_FORMAT_JSON" +], +"enumDescriptions": [ +"The default / unset value. The API will default to the YAML format.", +"YAML format.", +"JSON format." +], +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Labels as key value pairs", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the Template in the format `projects/*/locations/*/templates/*`.", +"type": "string" +}, +"updateTime": { +"description": "Output only. Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TemplateVersion": { +"description": "Message describing TemplateVersion resource", +"id": "TemplateVersion", +"properties": { +"createTime": { +"description": "Output only. Create time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"disabled": { +"description": "Optional. Disabled boolean to determine if a TemplateVersion acts as a metadata only resource (payload is never returned if disabled is true).", +"type": "boolean" +}, +"name": { +"description": "Identifier. The resource name of the TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`.", +"type": "string" +}, +"payload": { +"$ref": "TemplateVersionPayload", +"description": "Required. Immutable. Payload content of a TemplateVersion resource." +}, +"updateTime": { +"description": "Output only. Update time stamp", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TemplateVersionPayload": { +"description": "Message for storing a TemplateVersion resource's payload data", +"id": "TemplateVersionPayload", +"properties": { +"data": { +"description": "Required. bytes data for storing payload.", +"format": "byte", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", From 88d1110d7bc247f1f803b316177eacbe88fc8500 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:04 +0000 Subject: [PATCH 43/50] feat(playdeveloperreporting): update the api #### playdeveloperreporting:v1alpha1 The following keys were added: - schemas.ApiservingMcpMcpToolVisibility (Total Keys: 10) #### playdeveloperreporting:v1beta1 The following keys were added: - schemas.ApiservingMcpMcpToolVisibility (Total Keys: 10) --- .../playdeveloperreporting.v1alpha1.json | 49 ++++++++++++++++++- .../playdeveloperreporting.v1beta1.json | 49 ++++++++++++++++++- 2 files changed, 96 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index e54bf86fe3..27ce9ddc0f 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -1004,9 +1004,56 @@ } } }, -"revision": "20260423", +"revision": "20260709", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { +"ApiservingMcpMcpToolVisibility": { +"description": "Profile describing the visibility restriction of an MCP tool. Key: \"google.com/tool.profiles/visibility.restriction\"", +"id": "ApiservingMcpMcpToolVisibility", +"properties": { +"fieldVisibility": { +"description": "A list of field-level visibility restrictions.", +"items": { +"$ref": "ApiservingMcpMcpToolVisibilityFieldVisibility" +}, +"type": "array" +}, +"visibilityEnforcementStrategy": { +"description": "The strategy used to enforce visibility restrictions. DO NOT USE. This field is not yet implemented.", +"enum": [ +"VISIBILITY_ENFORCEMENT_STRATEGY_UNSPECIFIED", +"COMBINE", +"OVERRIDE" +], +"enumDescriptions": [ +"Default. Equivalent to COMBINE.", +"The principal must satisfy both API-level tool-level) visibility restrictions.", +"Bypasses the API-level visibility restrictions check; access is determined solely by the tool-level visibility restrictions." +], +"type": "string" +}, +"visibilityRestriction": { +"description": "The visibility restriction labels for the tool itself (e.g., \"PRODUCER_DEFINED_PREVIEW\"). Multiple labels can be provided as a comma-separated string.", +"type": "string" +} +}, +"type": "object" +}, +"ApiservingMcpMcpToolVisibilityFieldVisibility": { +"description": "Visibility rules for individual tool parameters (fields). This allows producers to hide specific fields in tools/list and tools/call.", +"id": "ApiservingMcpMcpToolVisibilityFieldVisibility", +"properties": { +"restriction": { +"description": "The visibility restriction labels for this field (comma-separated).", +"type": "string" +}, +"selector": { +"description": "The name of the parameter in the input_schema or output_schema.", +"type": "string" +} +}, +"type": "object" +}, "GooglePlayDeveloperReportingV1alpha1Anomaly": { "description": "Represents an anomaly detected in a dataset. Our anomaly detection systems flag datapoints in a time series that fall outside of and expected range derived from historical data. Although those expected ranges have an upper and a lower bound, we only flag anomalies when the data has become unexpectedly _worse_, which usually corresponds to the case where the metric crosses the upper bound. Multiple contiguous datapoints in a timeline outside of the expected range will be grouped into a single anomaly. Therefore, an anomaly represents effectively a segment of a metric's timeline. The information stored in the `timeline_spec`, `dimensions` and `metric` can be used to fetch a full timeline with extended ragne for context. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app.", "id": "GooglePlayDeveloperReportingV1alpha1Anomaly", diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 6f404548c4..0aa8d0c62d 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -1004,9 +1004,56 @@ } } }, -"revision": "20260423", +"revision": "20260709", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { +"ApiservingMcpMcpToolVisibility": { +"description": "Profile describing the visibility restriction of an MCP tool. Key: \"google.com/tool.profiles/visibility.restriction\"", +"id": "ApiservingMcpMcpToolVisibility", +"properties": { +"fieldVisibility": { +"description": "A list of field-level visibility restrictions.", +"items": { +"$ref": "ApiservingMcpMcpToolVisibilityFieldVisibility" +}, +"type": "array" +}, +"visibilityEnforcementStrategy": { +"description": "The strategy used to enforce visibility restrictions. DO NOT USE. This field is not yet implemented.", +"enum": [ +"VISIBILITY_ENFORCEMENT_STRATEGY_UNSPECIFIED", +"COMBINE", +"OVERRIDE" +], +"enumDescriptions": [ +"Default. Equivalent to COMBINE.", +"The principal must satisfy both API-level tool-level) visibility restrictions.", +"Bypasses the API-level visibility restrictions check; access is determined solely by the tool-level visibility restrictions." +], +"type": "string" +}, +"visibilityRestriction": { +"description": "The visibility restriction labels for the tool itself (e.g., \"PRODUCER_DEFINED_PREVIEW\"). Multiple labels can be provided as a comma-separated string.", +"type": "string" +} +}, +"type": "object" +}, +"ApiservingMcpMcpToolVisibilityFieldVisibility": { +"description": "Visibility rules for individual tool parameters (fields). This allows producers to hide specific fields in tools/list and tools/call.", +"id": "ApiservingMcpMcpToolVisibilityFieldVisibility", +"properties": { +"restriction": { +"description": "The visibility restriction labels for this field (comma-separated).", +"type": "string" +}, +"selector": { +"description": "The name of the parameter in the input_schema or output_schema.", +"type": "string" +} +}, +"type": "object" +}, "GooglePlayDeveloperReportingV1beta1Anomaly": { "description": "Represents an anomaly detected in a dataset. Our anomaly detection systems flag datapoints in a time series that fall outside of and expected range derived from historical data. Although those expected ranges have an upper and a lower bound, we only flag anomalies when the data has become unexpectedly _worse_, which usually corresponds to the case where the metric crosses the upper bound. Multiple contiguous datapoints in a timeline outside of the expected range will be grouped into a single anomaly. Therefore, an anomaly represents effectively a segment of a metric's timeline. The information stored in the `timeline_spec`, `dimensions` and `metric` can be used to fetch a full timeline with extended ragne for context. **Required permissions**: to access this resource, the calling user needs the _View app information (read-only)_ permission for the app.", "id": "GooglePlayDeveloperReportingV1beta1Anomaly", From 63ea8d84b2866c9ba98bc64b661d95c828dd2754 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:05 +0000 Subject: [PATCH 44/50] feat(saasservicemgmt): update the api #### saasservicemgmt:v1beta1 The following keys were deleted: - schemas.UnitKind.properties.applicationTemplateComponent.readOnly (Total Keys: 1) --- ...beta1.projects.locations.flagReleases.html | 24 ++++++------- ...t_v1beta1.projects.locations.releases.html | 36 +++++++++---------- ...emgmt_v1beta1.projects.locations.saas.html | 12 +++---- ..._v1beta1.projects.locations.unitKinds.html | 36 +++++++++---------- .../documents/saasservicemgmt.v1beta1.json | 15 ++++---- 5 files changed, 61 insertions(+), 62 deletions(-) diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html index 529eeb2338..fd7fbff42f 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.flagReleases.html @@ -124,7 +124,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -132,7 +132,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], @@ -174,7 +174,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -182,7 +182,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], @@ -249,7 +249,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -257,7 +257,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], @@ -309,7 +309,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -317,7 +317,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], @@ -378,7 +378,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -386,7 +386,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], @@ -428,7 +428,7 @@

Method Details

"flagRevisions": [ # Optional. Immutable. DEPRECATED: Use flag_revisions_release instead. FlagRevisions to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. It used to be the ultimate source to truth and has been moved to effective_flag_revisions. "A String", ], - "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consists of a list of flag revisions. + "flagRevisionsRelease": { # Wrapper for a list of flag revisions. # Optional. Immutable. Specifies the release consisting of a list of flag revisions. "revisions": [ # Required. FlagRevisions to be rolled out. "A String", ], @@ -436,7 +436,7 @@

Method Details

"flagSets": [ # Optional. Immutable. DEPRECATED: Use flag_sets_release instead. Flag sets to be rolled out. Only one of flag_revisions, all_flags, or flag_sets can be set. "A String", ], - "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consists of a list of flag sets. + "flagSetsRelease": { # Wrapper for a list of flag sets. # Optional. Immutable. Specifies the release consisting of a list of flag sets. "sets": [ # Required. Flag sets to be rolled out. "A String", ], diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html index d77b64272a..663de22e27 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.releases.html @@ -114,9 +114,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -180,9 +180,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -271,9 +271,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -348,9 +348,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -432,9 +432,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -498,9 +498,9 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Output only. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html index 05db7e8efb..ead6a332c0 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.saas.html @@ -114,7 +114,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -169,7 +169,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -249,7 +249,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -315,7 +315,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -388,7 +388,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -443,7 +443,7 @@

Method Details

"annotations": { # Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations "a_key": "A String", }, - "applicationTemplate": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. + "applicationTemplate": { # CompositeRef represents a reference to a composite resource. # Reference to composite ApplicationTemplate. When specified, the template components will be imported into their equivalent UnitKind, Release and Blueprint resources. Deleted references will not delete imported resources. Should only be specified on source regions, and be unspecified on replica regions. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. diff --git a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html index 84246edf86..38a7bf02db 100644 --- a/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html +++ b/docs/dyn/saasservicemgmt_v1beta1.projects.locations.unitKinds.html @@ -120,9 +120,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -200,9 +200,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -305,9 +305,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -396,9 +396,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -494,9 +494,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. @@ -574,9 +574,9 @@

Method Details

"type": "A String", # Required. Scope Type. }, }, - "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. Next ID: 4 # Output only. Reference to component and revision in a composite ApplicationTemplate. - "component": "A String", # Name of the component in composite.Components - "compositeRef": { # CompositeRef represents a reference to a composite resource. Next ID: 4 # Reference to the Composite ApplicationTemplate. + "applicationTemplateComponent": { # ComponentRef represents a reference to a component resource. # Optional. Reference to component and revision in a composite ApplicationTemplate. + "component": "A String", # Optional. Name of the component in composite.Components + "compositeRef": { # CompositeRef represents a reference to a composite resource. # Reference to the Composite ApplicationTemplate. "applicationTemplate": "A String", # Required. Reference to the ApplicationTemplate resource. "revision": "A String", # Revision of the ApplicationTemplate to use. Changes to revision will trigger manual resynchronization. If empty, ApplicationTemplate will be ignored. "syncOperation": "A String", # Output only. Reference to on-going AppTemplate import and replication operation (i.e. the operation_id for the long-running operation). This field is opaque for external usage. diff --git a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json index a86cbeb497..899588cccb 100644 --- a/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/saasservicemgmt.v1beta1.json @@ -3218,7 +3218,7 @@ } } }, -"revision": "20260610", +"revision": "20260624", "rootUrl": "https://saasservicemgmt.googleapis.com/", "schemas": { "Aggregate": { @@ -3316,11 +3316,11 @@ "type": "object" }, "ComponentRef": { -"description": "ComponentRef represents a reference to a component resource. Next ID: 4", +"description": "ComponentRef represents a reference to a component resource.", "id": "ComponentRef", "properties": { "component": { -"description": "Name of the component in composite.Components", +"description": "Optional. Name of the component in composite.Components", "type": "string" }, "compositeRef": { @@ -3335,7 +3335,7 @@ "type": "object" }, "CompositeRef": { -"description": "CompositeRef represents a reference to a composite resource. Next ID: 4", +"description": "CompositeRef represents a reference to a composite resource.", "id": "CompositeRef", "properties": { "applicationTemplate": { @@ -3744,7 +3744,7 @@ }, "flagRevisionsRelease": { "$ref": "FlagRevisionList", -"description": "Optional. Immutable. Specifies the release consists of a list of flag revisions." +"description": "Optional. Immutable. Specifies the release consisting of a list of flag revisions." }, "flagSets": { "deprecated": true, @@ -3756,7 +3756,7 @@ }, "flagSetsRelease": { "$ref": "FlagSetList", -"description": "Optional. Immutable. Specifies the release consists of a list of flag sets." +"description": "Optional. Immutable. Specifies the release consisting of a list of flag sets." }, "labels": { "additionalProperties": { @@ -5538,8 +5538,7 @@ }, "applicationTemplateComponent": { "$ref": "ComponentRef", -"description": "Output only. Reference to component and revision in a composite ApplicationTemplate.", -"readOnly": true +"description": "Optional. Reference to component and revision in a composite ApplicationTemplate." }, "boundaryType": { "description": "Optional. Output only. BoundaryType describes the type of boundary the Unit Kind represents.", From 2db22e303eafd6e27877e015154f3f00b4f76a9d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:05 +0000 Subject: [PATCH 45/50] feat(secretmanager): update the api #### secretmanager:v1 The following keys were added: - resources.projects.resources.locations.resources.secrets.methods.enableManagedRotation (Total Keys: 12) - resources.projects.resources.locations.resources.secrets.methods.rotateSecret (Total Keys: 12) - resources.projects.resources.secrets.methods.enableManagedRotation (Total Keys: 12) - resources.projects.resources.secrets.methods.rotateSecret (Total Keys: 12) - schemas.CloudSQLSingleUserCredentials (Total Keys: 5) - schemas.EnableManagedRotationRequest (Total Keys: 3) - schemas.ManagedRotationStatus (Total Keys: 6) - schemas.ResourcePolicyMember (Total Keys: 6) - schemas.RotateSecretRequest (Total Keys: 2) - schemas.Rotation.properties.managedRotationStatus (Total Keys: 2) - schemas.Secret.properties.policyMember (Total Keys: 2) - schemas.Secret.properties.secretType.type (Total Keys: 1) --- ...manager_v1.projects.locations.secrets.html | 215 +++++++++++++++++ .../secretmanager_v1.projects.secrets.html | 215 +++++++++++++++++ .../documents/secretmanager.v1.json | 224 +++++++++++++++++- 3 files changed, 653 insertions(+), 1 deletion(-) diff --git a/docs/dyn/secretmanager_v1.projects.locations.secrets.html b/docs/dyn/secretmanager_v1.projects.locations.secrets.html index cd63274206..cf7b8d3147 100644 --- a/docs/dyn/secretmanager_v1.projects.locations.secrets.html +++ b/docs/dyn/secretmanager_v1.projects.locations.secrets.html @@ -91,6 +91,9 @@

Instance Methods

delete(name, etag=None, x__xgafv=None)

Deletes a Secret.

+

+ enableManagedRotation(parent, body=None, x__xgafv=None)

+

Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.

get(name, x__xgafv=None)

Gets metadata for a given Secret.

@@ -106,6 +109,9 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates metadata of an existing Secret.

+

+ rotateSecret(parent, body=None, x__xgafv=None)

+

Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

@@ -196,6 +202,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -214,9 +224,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -255,6 +278,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -273,9 +300,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -311,6 +351,62 @@

Method Details

}
+
+ enableManagedRotation(parent, body=None, x__xgafv=None) +
Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.
+
+Args:
+  parent: string, Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SecretManagerService.EnableManagedRotation.
+  "cloudSqlSingleUserCredentials": { # These are the credentials required for Cloud SQL DB for Single user Managed Rotation. # Credentials required for Cloud SQL DB for Single user Managed Rotation.
+    "instanceId": "A String", # Required. Instance ID of the Cloud SQL instance.
+    "password": "A String", # Optional. Password of the Cloud SQL instance. If this is not provided, a random password will be generated.
+    "username": "A String", # Required. Username of the Cloud SQL instance.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret version resource in the Secret Manager API.
+  "clientSpecifiedPayloadChecksum": True or False, # Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
+  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
+  "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.
+    "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+  },
+  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+  "etag": "A String", # Output only. Etag of the currently stored SecretVersion.
+  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
+  "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+    "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+      "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+        "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+      },
+    },
+    "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+      "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+        { # Describes the status of a user-managed replica for the SecretVersion.
+          "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+            "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+          },
+          "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+        },
+      ],
+    },
+  },
+  "scheduledDestroyTime": "A String", # Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.
+  "state": "A String", # Output only. The current state of the SecretVersion.
+}
+
+
get(name, x__xgafv=None)
Gets metadata for a given Secret.
@@ -339,6 +435,10 @@ 

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -357,9 +457,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -458,6 +571,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -476,9 +593,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -535,6 +665,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -553,9 +687,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -594,6 +741,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -612,9 +763,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -631,6 +795,57 @@

Method Details

}
+
+ rotateSecret(parent, body=None, x__xgafv=None) +
Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.
+
+Args:
+  parent: string, Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SecretManagerService.RotateSecret.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret version resource in the Secret Manager API.
+  "clientSpecifiedPayloadChecksum": True or False, # Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
+  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
+  "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.
+    "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+  },
+  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+  "etag": "A String", # Output only. Etag of the currently stored SecretVersion.
+  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
+  "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+    "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+      "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+        "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+      },
+    },
+    "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+      "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+        { # Describes the status of a user-managed replica for the SecretVersion.
+          "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+            "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+          },
+          "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+        },
+      ],
+    },
+  },
+  "scheduledDestroyTime": "A String", # Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.
+  "state": "A String", # Output only. The current state of the SecretVersion.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.
diff --git a/docs/dyn/secretmanager_v1.projects.secrets.html b/docs/dyn/secretmanager_v1.projects.secrets.html
index 12ac727fda..4efe7010ba 100644
--- a/docs/dyn/secretmanager_v1.projects.secrets.html
+++ b/docs/dyn/secretmanager_v1.projects.secrets.html
@@ -91,6 +91,9 @@ 

Instance Methods

delete(name, etag=None, x__xgafv=None)

Deletes a Secret.

+

+ enableManagedRotation(parent, body=None, x__xgafv=None)

+

Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.

get(name, x__xgafv=None)

Gets metadata for a given Secret.

@@ -106,6 +109,9 @@

Instance Methods

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates metadata of an existing Secret.

+

+ rotateSecret(parent, body=None, x__xgafv=None)

+

Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.

setIamPolicy(resource, body=None, x__xgafv=None)

Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.

@@ -196,6 +202,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -214,9 +224,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -255,6 +278,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -273,9 +300,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -311,6 +351,62 @@

Method Details

}
+
+ enableManagedRotation(parent, body=None, x__xgafv=None) +
Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.
+
+Args:
+  parent: string, Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SecretManagerService.EnableManagedRotation.
+  "cloudSqlSingleUserCredentials": { # These are the credentials required for Cloud SQL DB for Single user Managed Rotation. # Credentials required for Cloud SQL DB for Single user Managed Rotation.
+    "instanceId": "A String", # Required. Instance ID of the Cloud SQL instance.
+    "password": "A String", # Optional. Password of the Cloud SQL instance. If this is not provided, a random password will be generated.
+    "username": "A String", # Required. Username of the Cloud SQL instance.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret version resource in the Secret Manager API.
+  "clientSpecifiedPayloadChecksum": True or False, # Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
+  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
+  "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.
+    "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+  },
+  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+  "etag": "A String", # Output only. Etag of the currently stored SecretVersion.
+  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
+  "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+    "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+      "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+        "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+      },
+    },
+    "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+      "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+        { # Describes the status of a user-managed replica for the SecretVersion.
+          "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+            "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+          },
+          "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+        },
+      ],
+    },
+  },
+  "scheduledDestroyTime": "A String", # Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.
+  "state": "A String", # Output only. The current state of the SecretVersion.
+}
+
+
get(name, x__xgafv=None)
Gets metadata for a given Secret.
@@ -339,6 +435,10 @@ 

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -357,9 +457,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -458,6 +571,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -476,9 +593,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -535,6 +665,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -553,9 +687,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -594,6 +741,10 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. The resource name of the Secret in the format `projects/*/secrets/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret. + "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` + "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` + }, "replication": { # A policy that defines the replication and encryption configuration of data. # Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. "automatic": { # A replication policy that replicates the Secret payload without any restrictions. # The Secret will automatically be replicated without any restrictions. "customerManagedEncryption": { # Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK). # Optional. The customer-managed encryption configuration of the Secret. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. @@ -612,9 +763,22 @@

Method Details

}, }, "rotation": { # The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. # Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy. + "managedRotationStatus": { # Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation. # Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user. + "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). # Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors. + "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. + }, + "state": "A String", # Output only. Indicates whether the Managed Rotation is active or not. + }, "nextRotationTime": "A String", # Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set. "rotationPeriod": "A String", # Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications. }, + "secretType": "A String", # Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type. "tags": { # Optional. Input only. Immutable. Mapping of Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, @@ -631,6 +795,57 @@

Method Details

}
+
+ rotateSecret(parent, body=None, x__xgafv=None) +
Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.
+
+Args:
+  parent: string, Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SecretManagerService.RotateSecret.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A secret version resource in the Secret Manager API.
+  "clientSpecifiedPayloadChecksum": True or False, # Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion.
+  "createTime": "A String", # Output only. The time at which the SecretVersion was created.
+  "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.
+    "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+  },
+  "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED.
+  "etag": "A String", # Output only. Etag of the currently stored SecretVersion.
+  "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret.
+  "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion.
+    "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy.
+      "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+        "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+      },
+    },
+    "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy.
+      "replicas": [ # Output only. The list of replica statuses for the SecretVersion.
+        { # Describes the status of a user-managed replica for the SecretVersion.
+          "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used.
+            "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`.
+          },
+          "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`.
+        },
+      ],
+    },
+  },
+  "scheduledDestroyTime": "A String", # Optional. Output only. Scheduled destroy time for secret version. This is a part of the Delayed secret version destroy feature. For a Secret with a valid version destroy TTL, when a secert version is destroyed, version is moved to disabled state and it is scheduled for destruction Version is destroyed only after the scheduled_destroy_time.
+  "state": "A String", # Output only. The current state of the SecretVersion.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.
diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
index 7310bb9fd0..51ccebd5c8 100644
--- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json
@@ -528,6 +528,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"enableManagedRotation": {
+"description": "Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:enableManagedRotation",
+"httpMethod": "POST",
+"id": "secretmanager.projects.locations.secrets.enableManagedRotation",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:enableManagedRotation",
+"request": {
+"$ref": "EnableManagedRotationRequest"
+},
+"response": {
+"$ref": "SecretVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets metadata for a given Secret.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}",
@@ -659,6 +687,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"rotateSecret": {
+"description": "Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:rotateSecret",
+"httpMethod": "POST",
+"id": "secretmanager.projects.locations.secrets.rotateSecret",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/secrets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:rotateSecret",
+"request": {
+"$ref": "RotateSecretRequest"
+},
+"response": {
+"$ref": "SecretVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "setIamPolicy": {
 "description": "Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/secrets/{secretsId}:setIamPolicy",
@@ -993,6 +1049,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"enableManagedRotation": {
+"description": "Enables the managed rotation feature for a Secret. This method can only be triggered once for a secret. In order to do further rotations, RotateSecret should be used. This method will add a secret version and update the password in Cloud SQL.",
+"flatPath": "v1/projects/{projectsId}/secrets/{secretsId}:enableManagedRotation",
+"httpMethod": "POST",
+"id": "secretmanager.projects.secrets.enableManagedRotation",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/secrets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:enableManagedRotation",
+"request": {
+"$ref": "EnableManagedRotationRequest"
+},
+"response": {
+"$ref": "SecretVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "get": {
 "description": "Gets metadata for a given Secret.",
 "flatPath": "v1/projects/{projectsId}/secrets/{secretsId}",
@@ -1124,6 +1208,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"rotateSecret": {
+"description": "Do a managed rotation for a Secret. This can only be triggered after Managed rotation has been enabled. This method will add a secret version and update the password in Cloud SQL.",
+"flatPath": "v1/projects/{projectsId}/secrets/{secretsId}:rotateSecret",
+"httpMethod": "POST",
+"id": "secretmanager.projects.secrets.rotateSecret",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/*/secrets/*` or `projects/*/locations/*/secrets/*`.",
+"location": "path",
+"pattern": "^projects/[^/]+/secrets/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}:rotateSecret",
+"request": {
+"$ref": "RotateSecretRequest"
+},
+"response": {
+"$ref": "SecretVersion"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "setIamPolicy": {
 "description": "Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret.",
 "flatPath": "v1/projects/{projectsId}/secrets/{secretsId}:setIamPolicy",
@@ -1366,7 +1478,7 @@
 }
 }
 },
-"revision": "20260424",
+"revision": "20260705",
 "rootUrl": "https://secretmanager.googleapis.com/",
 "schemas": {
 "AccessSecretVersionResponse": {
@@ -1488,6 +1600,25 @@
 },
 "type": "object"
 },
+"CloudSQLSingleUserCredentials": {
+"description": "These are the credentials required for Cloud SQL DB for Single user Managed Rotation.",
+"id": "CloudSQLSingleUserCredentials",
+"properties": {
+"instanceId": {
+"description": "Required. Instance ID of the Cloud SQL instance.",
+"type": "string"
+},
+"password": {
+"description": "Optional. Password of the Cloud SQL instance. If this is not provided, a random password will be generated.",
+"type": "string"
+},
+"username": {
+"description": "Required. Username of the Cloud SQL instance.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "CustomerManagedEncryption": {
 "description": "Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).",
 "id": "CustomerManagedEncryption",
@@ -1538,6 +1669,17 @@
 "properties": {},
 "type": "object"
 },
+"EnableManagedRotationRequest": {
+"description": "Request message for SecretManagerService.EnableManagedRotation.",
+"id": "EnableManagedRotationRequest",
+"properties": {
+"cloudSqlSingleUserCredentials": {
+"$ref": "CloudSQLSingleUserCredentials",
+"description": "Credentials required for Cloud SQL DB for Single user Managed Rotation."
+}
+},
+"type": "object"
+},
 "EnableSecretVersionRequest": {
 "description": "Request message for SecretManagerService.EnableSecretVersion.",
 "id": "EnableSecretVersionRequest",
@@ -1670,6 +1812,33 @@
 },
 "type": "object"
 },
+"ManagedRotationStatus": {
+"description": "Represents the status of a managed rotation. This is applicable only to Typed Secrets. It indicates whether the rotation is active and any errors that may have occurred during the asynchronous managed rotation.",
+"id": "ManagedRotationStatus",
+"properties": {
+"error": {
+"$ref": "Status",
+"description": "Output only. Displays customer-facing issues that occurred during an asynchronous managed rotation. For example, if there are some permission errors.",
+"readOnly": true
+},
+"state": {
+"description": "Output only. Indicates whether the Managed Rotation is active or not.",
+"enum": [
+"STATE_UNSPECIFIED",
+"ACTIVE",
+"INACTIVE"
+],
+"enumDescriptions": [
+"Not specified. This value is unused and invalid.",
+"Indicates that the Managed rotation is ACTIVE.",
+"Indicates that the Managed rotation is INACTIVE."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",
@@ -1872,10 +2041,38 @@
 },
 "type": "object"
 },
+"ResourcePolicyMember": {
+"description": "Output-only policy member strings of a Google Cloud resource's built-in identity.",
+"id": "ResourcePolicyMember",
+"properties": {
+"iamPolicyNamePrincipal": {
+"description": "Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter`",
+"readOnly": true,
+"type": "string"
+},
+"iamPolicyUidPrincipal": {
+"description": "Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5`",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"RotateSecretRequest": {
+"description": "Request message for SecretManagerService.RotateSecret.",
+"id": "RotateSecretRequest",
+"properties": {},
+"type": "object"
+},
 "Rotation": {
 "description": "The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.",
 "id": "Rotation",
 "properties": {
+"managedRotationStatus": {
+"$ref": "ManagedRotationStatus",
+"description": "Output only. The current status of the managed rotation. This field is only applicable to Typed Secrets. This field is set by the service and cannot be set by the user.",
+"readOnly": true
+},
 "nextRotationTime": {
 "description": "Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.",
 "format": "google-datetime",
@@ -1931,6 +2128,11 @@
 "readOnly": true,
 "type": "string"
 },
+"policyMember": {
+"$ref": "ResourcePolicyMember",
+"description": "Output only. Defines the policy member for the secret. This will be used to check if the caller has the permission to perform certain operations on the typed secret.",
+"readOnly": true
+},
 "replication": {
 "$ref": "Replication",
 "description": "Optional. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created."
@@ -1939,6 +2141,26 @@
 "$ref": "Rotation",
 "description": "Optional. Rotation policy attached to the Secret. May be excluded if there is no rotation policy."
 },
+"secretType": {
+"description": "Optional. Immutable. This defines the type of the secret. Enforces certain structural requirements on the SecretVersions. For secret of type UNSPECIFIED, the SecretVersions can be of any type.",
+"enum": [
+"SECRET_TYPE_UNSPECIFIED",
+"CLOUD_SQL_DB_CREDENTIALS",
+"ACCESS_KEY",
+"CERTIFICATE",
+"OTHER_DB_CREDENTIALS",
+"OTHER"
+],
+"enumDescriptions": [
+"Applicable to all secrets which do not have any restriction on the SecretVersions.",
+"Applicable to secrets which are used for the managed rotation feature for Cloud SQL Single User.",
+"Applicable to secrets where the payload contains an access key.",
+"Applicable to secrets where the payload contains a certificate.",
+"Applicable to secrets where the payload contains database credentials.",
+"Applicable to secrets whose type doesn't belong to any of the above defined types."
+],
+"type": "string"
+},
 "tags": {
 "additionalProperties": {
 "type": "string"

From 9435d481a01080c249031d1287931608f1e0ce47 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Jul 2026 07:42:06 +0000
Subject: [PATCH 46/50] feat(sqladmin): update the api

#### sqladmin:v1

The following keys were added:
- resources.instances.methods.patch.parameters.reconcilePscNetworking (Total Keys: 4)
- schemas.BackupConfiguration.properties.replicationLogArchivingEnabled.deprecated (Total Keys: 1)
- schemas.ConnectSettings.properties.connectionName (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.cpuUtilizationThresholdPercent (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.historyListLengthThresholdCount (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.memoryUsageThresholdPercent (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.semaphoreWaitThresholdCount (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillExcludedUserHosts (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillThresholdSeconds (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillType.type (Total Keys: 1)
- schemas.PerformanceCaptureConfig.properties.transactionLockWaitThresholdCount (Total Keys: 2)
- schemas.PscAutoConnectionConfig.properties.instanceAutoDnsStatus (Total Keys: 2)
- schemas.PscAutoConnectionConfig.properties.writeEndpointAutoDnsStatus (Total Keys: 2)

The following keys were changed:
- resources.connect.methods.resolve (Total Keys: 3)

#### sqladmin:v1beta4

The following keys were added:
- resources.instances.methods.patch.parameters.reconcilePscNetworking (Total Keys: 4)
- schemas.BackupConfiguration.properties.replicationLogArchivingEnabled.deprecated (Total Keys: 1)
- schemas.ConnectSettings.properties.connectionName (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.cpuUtilizationThresholdPercent (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.historyListLengthThresholdCount (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.memoryUsageThresholdPercent (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.semaphoreWaitThresholdCount (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillExcludedUserHosts (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillThresholdSeconds (Total Keys: 2)
- schemas.PerformanceCaptureConfig.properties.transactionKillType.type (Total Keys: 1)
- schemas.PerformanceCaptureConfig.properties.transactionLockWaitThresholdCount (Total Keys: 2)
- schemas.PscAutoConnectionConfig.properties.instanceAutoDnsStatus (Total Keys: 2)
- schemas.PscAutoConnectionConfig.properties.writeEndpointAutoDnsStatus (Total Keys: 2)

The following keys were changed:
- resources.connect.methods.resolve (Total Keys: 3)
---
 docs/dyn/sqladmin_v1.Backups.html             |  64 +++++++++-
 docs/dyn/sqladmin_v1.connect.html             |   8 +-
 docs/dyn/sqladmin_v1.instances.html           | 118 +++++++++++++++--
 docs/dyn/sqladmin_v1beta4.backups.html        |  64 +++++++++-
 docs/dyn/sqladmin_v1beta4.connect.html        |   8 +-
 docs/dyn/sqladmin_v1beta4.instances.html      | 118 +++++++++++++++--
 .../documents/sqladmin.v1.json                | 113 ++++++++++++++++-
 .../documents/sqladmin.v1beta4.json           | 120 ++++++++++++++++--
 8 files changed, 567 insertions(+), 46 deletions(-)

diff --git a/docs/dyn/sqladmin_v1.Backups.html b/docs/dyn/sqladmin_v1.Backups.html
index c5d50049a0..36cd0d7e1c 100644
--- a/docs/dyn/sqladmin_v1.Backups.html
+++ b/docs/dyn/sqladmin_v1.Backups.html
@@ -204,10 +204,12 @@ 

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -324,7 +326,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -412,10 +414,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -451,12 +455,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -957,10 +971,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1077,7 +1093,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -1165,10 +1181,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -1204,12 +1222,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -1396,10 +1424,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1516,7 +1546,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -1604,10 +1634,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -1643,12 +1675,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -1849,10 +1891,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1969,7 +2013,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -2057,10 +2101,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -2096,12 +2142,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. diff --git a/docs/dyn/sqladmin_v1.connect.html b/docs/dyn/sqladmin_v1.connect.html index ff13c6b249..377e406374 100644 --- a/docs/dyn/sqladmin_v1.connect.html +++ b/docs/dyn/sqladmin_v1.connect.html @@ -84,7 +84,7 @@

Instance Methods

get(project, instance, readTime=None, x__xgafv=None)

Retrieves connect settings about a Cloud SQL instance.

- resolve(dnsName, location, x__xgafv=None)

+ resolve(location, dnsName, x__xgafv=None)

Retrieves connect settings about a Cloud SQL instance using the instance DNS name.

Method Details

@@ -150,6 +150,7 @@

Method Details

{ # Connect settings retrieval response. "backendType": "A String", # `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance. "customSubjectAlternativeNames": [ # Custom subject alternative names for the server certificate. "A String", ], @@ -214,12 +215,12 @@

Method Details

- resolve(dnsName, location, x__xgafv=None) + resolve(location, dnsName, x__xgafv=None)
Retrieves connect settings about a Cloud SQL instance using the instance DNS name.
 
 Args:
-  dnsName: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
   location: string, Required. The region of the instance. (required)
+  dnsName: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -230,6 +231,7 @@ 

Method Details

{ # Connect settings retrieval response. "backendType": "A String", # `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance. "customSubjectAlternativeNames": [ # Custom subject alternative names for the server certificate. "A String", ], diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 18f2d4073f..8d19575cb7 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -141,7 +141,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(project, instance, body=None, x__xgafv=None)

+ patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

pointInTimeRestore(parent, body=None, x__xgafv=None)

@@ -2431,10 +2431,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -2551,7 +2553,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -2639,10 +2641,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -2678,12 +2682,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3044,10 +3058,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -3164,7 +3180,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -3252,10 +3268,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -3291,12 +3309,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3608,10 +3636,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -3728,7 +3758,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -3816,10 +3846,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -3855,12 +3887,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3975,7 +4017,7 @@

Method Details

- patch(project, instance, body=None, x__xgafv=None) + patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)
Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
 
 Args:
@@ -4066,10 +4108,12 @@ 

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -4186,7 +4230,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -4274,10 +4318,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -4313,12 +4359,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -4372,6 +4428,8 @@

Method Details

"writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. } + reconcilePscNetworking: boolean, Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking. + reconcilePscNetworkingForce: boolean, Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -4632,10 +4690,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -4752,7 +4812,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -4840,10 +4900,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -4879,12 +4941,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -6075,10 +6147,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -6195,7 +6269,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -6283,10 +6357,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -6322,12 +6398,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -7472,10 +7558,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -7592,7 +7680,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs used to perform point-in-time recovery (PITR) for the database. @@ -7680,10 +7768,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -7719,12 +7809,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. diff --git a/docs/dyn/sqladmin_v1beta4.backups.html b/docs/dyn/sqladmin_v1beta4.backups.html index 2b470c09ab..dbc614bf64 100644 --- a/docs/dyn/sqladmin_v1beta4.backups.html +++ b/docs/dyn/sqladmin_v1beta4.backups.html @@ -209,10 +209,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -329,7 +331,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -417,10 +419,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -456,12 +460,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -962,10 +976,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1082,7 +1098,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -1170,10 +1186,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -1209,12 +1227,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -1401,10 +1429,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1521,7 +1551,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -1609,10 +1639,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -1648,12 +1680,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -1854,10 +1896,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -1974,7 +2018,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -2062,10 +2106,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -2101,12 +2147,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html index add4db8a6e..8902d8bba4 100644 --- a/docs/dyn/sqladmin_v1beta4.connect.html +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -84,7 +84,7 @@

Instance Methods

get(project, instance, readTime=None, x__xgafv=None)

Retrieves connect settings about a Cloud SQL instance.

- resolve(dnsName, location, x__xgafv=None)

+ resolve(location, dnsName, x__xgafv=None)

Retrieves connect settings about a Cloud SQL instance using the instance DNS name.

Method Details

@@ -150,6 +150,7 @@

Method Details

{ # Connect settings retrieval response. "backendType": "A String", # `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance. "customSubjectAlternativeNames": [ # Custom subject alternative names for the server certificate. "A String", ], @@ -214,12 +215,12 @@

Method Details

- resolve(dnsName, location, x__xgafv=None) + resolve(location, dnsName, x__xgafv=None)
Retrieves connect settings about a Cloud SQL instance using the instance DNS name.
 
 Args:
-  dnsName: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
   location: string, Required. The region of the instance. (required)
+  dnsName: string, Required. Cloud SQL instance ID. This does not include the project ID. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -230,6 +231,7 @@ 

Method Details

{ # Connect settings retrieval response. "backendType": "A String", # `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. + "connectionName": "A String", # Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance. "customSubjectAlternativeNames": [ # Custom subject alternative names for the server certificate. "A String", ], diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index f7c568e43f..ec08ce000a 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -141,7 +141,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

- patch(project, instance, body=None, x__xgafv=None)

+ patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

pointInTimeRestore(parent, body=None, x__xgafv=None)

@@ -2431,10 +2431,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -2551,7 +2553,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -2639,10 +2641,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -2678,12 +2682,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3044,10 +3058,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -3164,7 +3180,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -3252,10 +3268,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -3291,12 +3309,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3608,10 +3636,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -3728,7 +3758,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -3816,10 +3846,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -3855,12 +3887,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -3975,7 +4017,7 @@

Method Details

- patch(project, instance, body=None, x__xgafv=None) + patch(project, instance, body=None, reconcilePscNetworking=None, reconcilePscNetworkingForce=None, x__xgafv=None)
Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.
 
 Args:
@@ -4066,10 +4108,12 @@ 

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -4186,7 +4230,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -4274,10 +4318,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -4313,12 +4359,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -4372,6 +4428,8 @@

Method Details

"writeEndpoint": "A String", # Output only. The dns name of the primary instance in a replication group. } + reconcilePscNetworking: boolean, Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking. + reconcilePscNetworkingForce: boolean, Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -4632,10 +4690,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -4752,7 +4812,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -4840,10 +4900,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -4879,12 +4941,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -6075,10 +6147,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -6195,7 +6269,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -6283,10 +6357,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -6322,12 +6398,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. @@ -7472,10 +7558,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscServiceAttachmentLink": "A String", # Output only. The Private Service Connect (PSC) service attachment of the read pool node. @@ -7592,7 +7680,7 @@

Method Details

"kind": "A String", # This is always `sql#backupConfiguration`. "location": "A String", # Location of the backup "pointInTimeRecoveryEnabled": True or False, # Whether point in time recovery is enabled. - "replicationLogArchivingEnabled": True or False, # Reserved for future use. + "replicationLogArchivingEnabled": True or False, # Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - `HH:MM`. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. "transactionalLogStorageState": "A String", # Output only. This value contains the storage location of transactional logs for the database for point-in-time recovery. @@ -7680,10 +7768,12 @@

Method Details

"consumerNetwork": "A String", # Optional. The consumer network of this consumer endpoint. This must be a resource path that includes both the host project and the network name. For example, `projects/project1/global/networks/network1`. The consumer host project of this network might be different from the consumer service project. "consumerNetworkStatus": "A String", # The connection policy status of the consumer network. "consumerProject": "A String", # Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network. + "instanceAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning. "ipAddress": "A String", # The IP address of the consumer endpoint. "serviceConnectionPolicy": "A String", # Output only. The service connection policy created automatically for the consumer network when `psc_auto_connection_policy_enabled` is true. It is in the format of: `projects/{project}/regions/{region}/serviceConnectionPolicies/{policy_id}` The `policy_id` is in format of `$NETWORK-$RANDOM`. "serviceConnectionPolicyCreationResult": "A String", # Output only. The status of service connection policy creation. "status": "A String", # The connection status of the consumer endpoint. + "writeEndpointAutoDnsStatus": "A String", # Output only. The status of automated DNS provisioning for the write endpoint. }, ], "pscAutoDnsEnabled": True or False, # Optional. Indicates whether Private Service Connect DNS automation is enabled for this instance. When enabled, Cloud SQL provisions a universal DNS record across all networks configured with Private Service Connect auto-connections. This will default to true for new instances when Private Service Connect is enabled. @@ -7719,12 +7809,22 @@

Method Details

"reuseInterval": 42, # Number of previous passwords that cannot be reused. }, "performanceCaptureConfig": { # Performance capture configuration. # Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + "cpuUtilizationThresholdPercent": 42, # Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "enabled": True or False, # Optional. Enables or disables the performance capture feature. + "historyListLengthThresholdCount": 42, # Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check. + "memoryUsageThresholdPercent": 42, # Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check. "probeThreshold": 42, # Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture. "probingIntervalSeconds": 42, # Optional. Specifies the interval in seconds between consecutive probes that check if any trigger condition thresholds have been reached. "runningThreadsThreshold": 42, # Optional. Specifies the minimum number of MySQL `Threads_running` to trigger the performance capture on the primary instance. "secondsBehindSourceThreshold": 42, # Optional. Specifies the minimum number of seconds replica must be lagging behind primary instance to trigger the performance capture on replica. + "semaphoreWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. "transactionDurationThreshold": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + "transactionKillExcludedUserHosts": [ # Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `["app_user", "db_admin@10.1.2.3", "report_user@%"]` + "A String", + ], + "transactionKillThresholdSeconds": 42, # Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected. + "transactionKillType": "A String", # Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified. + "transactionLockWaitThresholdCount": 42, # Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check. }, "pricingPlan": "A String", # The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. "readPoolAutoScaleConfig": { # The read pool auto-scale configuration. # Optional. The read pool auto-scale configuration for the instance. diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 56607f8911..38d356c702 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -741,12 +741,12 @@ }, "resolve": { "description": "Retrieves connect settings about a Cloud SQL instance using the instance DNS name.", -"flatPath": "v1/dns/{dnsName}/locations/{location}:resolveConnectSettings", +"flatPath": "v1/locations/{location}/dns/{dnsName}:resolveConnectSettings", "httpMethod": "GET", "id": "sql.connect.resolve", "parameterOrder": [ -"dnsName", -"location" +"location", +"dnsName" ], "parameters": { "dnsName": { @@ -762,7 +762,7 @@ "type": "string" } }, -"path": "v1/dns/{dnsName}/locations/{location}:resolveConnectSettings", +"path": "v1/locations/{location}/dns/{dnsName}:resolveConnectSettings", "response": { "$ref": "ConnectSettings" }, @@ -1765,6 +1765,16 @@ "location": "path", "required": true, "type": "string" +}, +"reconcilePscNetworking": { +"description": "Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking.", +"location": "query", +"type": "boolean" +}, +"reconcilePscNetworkingForce": { +"description": "Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking.", +"location": "query", +"type": "boolean" } }, "path": "v1/projects/{project}/instances/{instance}", @@ -3059,7 +3069,7 @@ } } }, -"revision": "20260529", +"revision": "20260627", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3561,7 +3571,8 @@ false "type": "boolean" }, "replicationLogArchivingEnabled": { -"description": "Reserved for future use.", +"deprecated": true, +"description": "Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead.", "type": "boolean" }, "startTime": { @@ -4151,6 +4162,11 @@ false ], "type": "string" }, +"connectionName": { +"description": "Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance.", +"readOnly": true, +"type": "string" +}, "customSubjectAlternativeNames": { "description": "Custom subject alternative names for the server certificate.", "items": { @@ -7281,10 +7297,25 @@ false "description": "Performance capture configuration.", "id": "PerformanceCaptureConfig", "properties": { +"cpuUtilizationThresholdPercent": { +"description": "Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "enabled": { "description": "Optional. Enables or disables the performance capture feature.", "type": "boolean" }, +"historyListLengthThresholdCount": { +"description": "Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, +"memoryUsageThresholdPercent": { +"description": "Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "probeThreshold": { "description": "Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.", "format": "int32", @@ -7305,10 +7336,46 @@ false "format": "int32", "type": "integer" }, +"semaphoreWaitThresholdCount": { +"description": "Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "transactionDurationThreshold": { "description": "Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.", "format": "int32", "type": "integer" +}, +"transactionKillExcludedUserHosts": { +"description": "Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `[\"app_user\", \"db_admin@10.1.2.3\", \"report_user@%\"]`", +"items": { +"type": "string" +}, +"type": "array" +}, +"transactionKillThresholdSeconds": { +"description": "Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected.", +"format": "int32", +"type": "integer" +}, +"transactionKillType": { +"description": "Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified.", +"enum": [ +"TRANSACTION_KILL_TYPE_UNSPECIFIED", +"READ_ONLY_TRANSACTIONS", +"ALL_TRANSACTIONS" +], +"enumDescriptions": [ +"Unspecified.", +"Only read-only transactions are eligible for termination.", +"All transactions are eligible for termination, including those with write operations (such as INSERT, UPDATE, DELETE, or DDL)." +], +"type": "string" +}, +"transactionLockWaitThresholdCount": { +"description": "Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -7700,6 +7767,23 @@ false "description": "Optional. This is the project ID of consumer service project of this consumer endpoint. This is only applicable if `consumer_network` is a shared VPC network.", "type": "string" }, +"instanceAutoDnsStatus": { +"description": "Output only. The status of automated DNS provisioning.", +"enum": [ +"AUTO_DNS_STATUS_UNSPECIFIED", +"AUTO_DNS_OK", +"AUTO_DNS_FAILED", +"AUTO_DNS_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified status. This means status is missing from dependency service.", +"DNS provisioning is OK.", +"DNS provisioning failed.", +"DNS provisioning status is not recognized by Cloud SQL." +], +"readOnly": true, +"type": "string" +}, "ipAddress": { "description": "The IP address of the consumer endpoint.", "type": "string" @@ -7717,6 +7801,23 @@ false "status": { "description": "The connection status of the consumer endpoint.", "type": "string" +}, +"writeEndpointAutoDnsStatus": { +"description": "Output only. The status of automated DNS provisioning for the write endpoint.", +"enum": [ +"AUTO_DNS_STATUS_UNSPECIFIED", +"AUTO_DNS_OK", +"AUTO_DNS_FAILED", +"AUTO_DNS_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified status. This means status is missing from dependency service.", +"DNS provisioning is OK.", +"DNS provisioning failed.", +"DNS provisioning status is not recognized by Cloud SQL." +], +"readOnly": true, +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 107f3b4b5a..ad261324e5 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -741,12 +741,12 @@ }, "resolve": { "description": "Retrieves connect settings about a Cloud SQL instance using the instance DNS name.", -"flatPath": "sql/v1beta4/dns/{dnsName}/locations/{location}:resolveConnectSettings", +"flatPath": "sql/v1beta4/locations/{location}/dns/{dnsName}:resolveConnectSettings", "httpMethod": "GET", "id": "sql.connect.resolve", "parameterOrder": [ -"dnsName", -"location" +"location", +"dnsName" ], "parameters": { "dnsName": { @@ -762,7 +762,7 @@ "type": "string" } }, -"path": "sql/v1beta4/dns/{dnsName}/locations/{location}:resolveConnectSettings", +"path": "sql/v1beta4/locations/{location}/dns/{dnsName}:resolveConnectSettings", "response": { "$ref": "ConnectSettings" }, @@ -1765,6 +1765,16 @@ "location": "path", "required": true, "type": "string" +}, +"reconcilePscNetworking": { +"description": "Optional. Set PSC config to the same value as the existing config to reconcile the PSC networking.", +"location": "query", +"type": "boolean" +}, +"reconcilePscNetworkingForce": { +"description": "Optional. Set PSC config to the same value as the existing config and force reconcile the PSC networking.", +"location": "query", +"type": "boolean" } }, "path": "sql/v1beta4/projects/{project}/instances/{instance}", @@ -3059,7 +3069,7 @@ } } }, -"revision": "20260529", +"revision": "20260627", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -3561,7 +3571,8 @@ false "type": "boolean" }, "replicationLogArchivingEnabled": { -"description": "Reserved for future use.", +"deprecated": true, +"description": "Optional. Deprecated: replication_log_archiving_enabled is deprecated and will be removed from a future version of the API. Use point_in_time_recovery_enabled instead.", "type": "boolean" }, "startTime": { @@ -4151,6 +4162,11 @@ false ], "type": "string" }, +"connectionName": { +"description": "Optional. Output only. Connection name of the Cloud SQL instance used in connection strings, in the format project:region:instance.", +"readOnly": true, +"type": "string" +}, "customSubjectAlternativeNames": { "description": "Custom subject alternative names for the server certificate.", "items": { @@ -6933,7 +6949,8 @@ false "REPAIR_READ_POOL", "CREATE_READ_POOL", "PRE_CHECK_MAJOR_VERSION_UPGRADE", -"SETUP_MIGRATION" +"SETUP_MIGRATION", +"AGENT_SEND_MESSAGE" ], "enumDeprecated": [ false, @@ -6989,6 +7006,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -7045,7 +7063,8 @@ false "Repairs entire read pool or specified read pool nodes in the read pool.", "Creates a Cloud SQL read pool instance.", "Pre-checks for major version upgrade.", -"This operation type represents individual steps in a multi-step setup migration workflow: including configuration, replication, switchover/back, and data reseeding, as defined by operation's intent." +"This operation type represents individual steps in a multi-step setup migration workflow: including configuration, replication, switchover/back, and data reseeding, as defined by operation's intent.", +"Sends a message to a Cloud SQL agent." ], "type": "string" }, @@ -7282,10 +7301,25 @@ false "description": "Performance capture configuration.", "id": "PerformanceCaptureConfig", "properties": { +"cpuUtilizationThresholdPercent": { +"description": "Optional. Specifies the minimum percentage of CPU utilization to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "enabled": { "description": "Optional. Enables or disables the performance capture feature.", "type": "boolean" }, +"historyListLengthThresholdCount": { +"description": "Optional. Specifies the minimum number of undo log entries in the history list length to trigger the performance capture. Valid integers range from `10000` to `10000000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, +"memoryUsageThresholdPercent": { +"description": "Optional. Specifies the minimum percentage of memory usage to trigger the performance capture. Valid integers range from `10` to `99`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "probeThreshold": { "description": "Optional. Specifies the minimum number of consecutive probe threshold that triggers performance capture.", "format": "int32", @@ -7306,10 +7340,46 @@ false "format": "int32", "type": "integer" }, +"semaphoreWaitThresholdCount": { +"description": "Optional. Specifies the minimum allowed number of semaphore waits to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" +}, "transactionDurationThreshold": { "description": "Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.", "format": "int32", "type": "integer" +}, +"transactionKillExcludedUserHosts": { +"description": "Optional. Specifies a customer-defined list of users to exclude from transaction termination. Entries can be in the format 'user@host' or just 'user'. A standalone 'user' implies 'user@%', excluding the user from any host. Wildcard '%' is allowed in the host part of the 'user@host' format. Example: `[\"app_user\", \"db_admin@10.1.2.3\", \"report_user@%\"]`", +"items": { +"type": "string" +}, +"type": "array" +}, +"transactionKillThresholdSeconds": { +"description": "Optional. Specifies the amount of time in seconds that a transaction needs to have been open before the watcher starts terminating it. Valid integers range from `60` to `604800` (7 days). Enter `0` to disable. If enabled (i.e., > 0), this value must be greater than or equal to `transaction_duration_threshold`. Configurations where `0 < transaction_kill_threshold_seconds < transaction_duration_threshold` will be rejected.", +"format": "int32", +"type": "integer" +}, +"transactionKillType": { +"description": "Optional. Determines which transactions are allowed to be terminated when they exceed `transaction_kill_threshold_seconds`. This allows protecting write-heavy transactions from auto-termination if desired. Defaults to `READ_ONLY_TRANSACTIONS` if unspecified.", +"enum": [ +"TRANSACTION_KILL_TYPE_UNSPECIFIED", +"READ_ONLY_TRANSACTIONS", +"ALL_TRANSACTIONS" +], +"enumDescriptions": [ +"Unspecified.", +"Only read-only transactions are eligible for termination.", +"All transactions are eligible for termination, including those with write operations (such as INSERT, UPDATE, DELETE, or DDL)." +], +"type": "string" +}, +"transactionLockWaitThresholdCount": { +"description": "Optional. Specifies the minimum allowed number of transactions in lock wait state to trigger the performance capture. Valid integers range from `10` to `10000`. Enter `0` to disable the check.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -7701,6 +7771,23 @@ false "description": "Optional. This is the project ID of consumer service project of this consumer endpoint. Optional. This is only applicable if consumer_network is a shared vpc network.", "type": "string" }, +"instanceAutoDnsStatus": { +"description": "Output only. The status of automated DNS provisioning.", +"enum": [ +"AUTO_DNS_STATUS_UNSPECIFIED", +"AUTO_DNS_OK", +"AUTO_DNS_FAILED", +"AUTO_DNS_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified status. This means status is missing from dependency service.", +"DNS provisioning is OK.", +"DNS provisioning failed.", +"DNS provisioning status is not recognized by Cloud SQL." +], +"readOnly": true, +"type": "string" +}, "ipAddress": { "description": "The IP address of the consumer endpoint.", "type": "string" @@ -7718,6 +7805,23 @@ false "status": { "description": "The connection status of the consumer endpoint.", "type": "string" +}, +"writeEndpointAutoDnsStatus": { +"description": "Output only. The status of automated DNS provisioning for the write endpoint.", +"enum": [ +"AUTO_DNS_STATUS_UNSPECIFIED", +"AUTO_DNS_OK", +"AUTO_DNS_FAILED", +"AUTO_DNS_UNKNOWN" +], +"enumDescriptions": [ +"Unspecified status. This means status is missing from dependency service.", +"DNS provisioning is OK.", +"DNS provisioning failed.", +"DNS provisioning status is not recognized by Cloud SQL." +], +"readOnly": true, +"type": "string" } }, "type": "object" From e12cc5ce937bf463c24bc292119898b73a496e39 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:07 +0000 Subject: [PATCH 47/50] feat(tagmanager): update the api #### tagmanager:v2 The following keys were deleted: - schemas.CompilerErrorLite (Total Keys: 4) - schemas.CreateContainerVersionResponse.properties.compilerErrors (Total Keys: 2) - schemas.PublishContainerVersionResponse.properties.compilerErrors (Total Keys: 2) - schemas.QuickPreviewResponse.properties.compilerErrors (Total Keys: 2) --- ...nager_v2.accounts.containers.versions.html | 6 - ...ger_v2.accounts.containers.workspaces.html | 12 -- .../documents/tagmanager.v2.json | 139 +----------------- 3 files changed, 5 insertions(+), 152 deletions(-) diff --git a/docs/dyn/tagmanager_v2.accounts.containers.versions.html b/docs/dyn/tagmanager_v2.accounts.containers.versions.html index 8073fda983..de77b906a9 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.versions.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.versions.html @@ -1569,12 +1569,6 @@

Method Details

{ # Publish container version response. "compilerError": True or False, # Compiler errors or not. - "compilerErrors": [ # Compiler error details. - { - "errorMessage": "A String", - "errorType": "A String", - }, - ], "containerVersion": { # Represents a Google Tag Manager Container Version. # The container version created. "accountId": "A String", # GTM Account ID. "builtInVariable": [ # The built-in variables in the container that this version was taken from. diff --git a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html index 03b27ee3c2..a6017f140e 100644 --- a/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html +++ b/docs/dyn/tagmanager_v2.accounts.containers.workspaces.html @@ -1531,12 +1531,6 @@

Method Details

{ # Create container versions response. "compilerError": True or False, # Compiler errors or not. - "compilerErrors": [ # Compiler error details. - { - "errorMessage": "A String", - "errorType": "A String", - }, - ], "containerVersion": { # Represents a Google Tag Manager Container Version. # The container version created. "accountId": "A String", # GTM Account ID. "builtInVariable": [ # The built-in variables in the container that this version was taken from. @@ -4276,12 +4270,6 @@

Method Details

{ # Response to quick previewing a workspace. "compilerError": True or False, # Were there compiler errors or not. - "compilerErrors": [ # Compiler error details. - { - "errorMessage": "A String", - "errorType": "A String", - }, - ], "containerVersion": { # Represents a Google Tag Manager Container Version. # The quick previewed container version. "accountId": "A String", # GTM Account ID. "builtInVariable": [ # The built-in variables in the container that this version was taken from. diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index bb263f96a0..0b3ac16500 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3988,7 +3988,7 @@ } } }, -"revision": "20260608", +"revision": "20260706", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -4407,116 +4407,6 @@ }, "type": "object" }, -"CompilerErrorLite": { -"id": "CompilerErrorLite", -"properties": { -"errorMessage": { -"type": "string" -}, -"errorType": { -"enum": [ -"unknownErrorType", -"duplicateAutoEventName", -"duplicateConditionId", -"duplicateDefaultMacro", -"duplicateTagName", -"internalCompilerError", -"invalidMacroKey", -"invalidNumberPredicateArgs", -"invalidMacroFormat", -"invalidMacroNameReference", -"invalidMacroParameter", -"invalidUsageContext", -"invalidRegex", -"macroCycle", -"unknownConditionId", -"unknownMacroInstance", -"invalidManualEscaping", -"invalidHtmlCssJs", -"macroInCommentsError", -"jsCompilerError", -"jsonError", -"invalidTagParameter", -"javascriptTooLong", -"unknownTagInstance", -"invalidTagReference", -"unknownTriggerId", -"customTriggerMissingEventFilter", -"duplicateTriggerId", -"unsupportedTriggerType", -"invalidTriggerParameter", -"duplicateExperimentId", -"pixieCompilerError", -"macroNotServerSideResolvable", -"invalidBlockingTrigger", -"lineTooLong", -"invalidTypeInSelect", -"gaExperimentMacroIsDeprecated", -"unsafeHtmlContent", -"unsafeHtmlAttributeValue", -"unsafeCssContent", -"parameterReferenceNotFound", -"invalidCustomTemplateRuntimeCode", -"conflictingDestinationRouting", -"missingRequiredActivity", -"unresolvableDestinationTag", -"invalidDestinationTag", -"tosRequiredForThirdPartyTags" -], -"enumDescriptions": [ -"Unknown error type. Place holder for the enum's default value; not valid.", -"There are multiple auto-event instances with the same name. parent - N EntityKeys each with their auto_event_key populated.", -"There are multiple conditions with the same id. parent - N EntityKeys each with their condition_key populated.", -"There are multiple default macros with the same name. parent - N EntityKeys each with their macro_key populated. context - The macro name.", -"There are multiple tag instances with the same name. parent - N EntityKeys each with their tag_key populated.", -"An internal compiler invariant was broken. parent - 1 EntityKey which may have macro_key, condition_key, or tag_key populated. It's also possible that no keys are populated. context - An internal string (shouldn't be shown to the user) describing the problem.", -"An macro instance key was invalid e.g. foo#bar parent - 1 EntityKey with one of the following populated: macro_key, condition_key, tag_key. context - The string of the invalid name.", -"Wrong number of args passed to a predicate. parent - 1 EntityKey with its condition_key populated.", -"Macro format was invalid e.g. foo#bar parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The full string of the invalid macro and surrounding literals.", -"A macro name was referenced instead of a macro key. parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The name of the invalid macro name.", -"Macro had an invalid parameter. This could be anything from a parameter being a complex type or a macro parameter containing a macro reference. parent - 1 EntityKey with its macro_key populated. context - The value of the offending parameter if it is string-able.", -"Usage context of a container was invalid. Currently, this error can occur when a container context specifies both web and mobile. The UI shouldn't allowed creating such a mixed container. parent - not set context - The description of the context", -"Contents of an Regex predicate had an invalid pattern. parent - 1 EntityKey with one of the following populated: condition_key. context - The offending pattern.", -"There was a macro whose resolution would depend on itself. parent - N EntityKeys each with their macro_key, trigger_key, or condition_key populated. This represents the macro cycle. context - Empty.", -"A condition id was used which doesn't exist in the conditions list. parent - 1 EntityKey with its tag_key populated. context - The integer id of the missing conditional.", -"A macro name was used which doesn't exist in the macro list. parent - 1 EntityKey with one of the following populated: condition_key, tag_key. context - The name of the missing macro instance.", -"User-provided escaping inappropriate for the context in which it is used. parent - 1 EntityKey with one of the following populated: macro_key, condition_key, tag_key. context - Empty.", -"Auto-escaped content is not valid HTML, CSS or JavaScript. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", -"Macro reference found inside an HTML, CSS or JavaScript comment. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", -"Contents of an HTML script tag could not be compiled by JsCompiler. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", -"Contents of a ConfigurationValue script tag could not be parsed by the JSON parser. parent - 1 EntityKey with one of the following populated: tag_key. context - Empty.", -"Tag had an invalid parameter. This could be anything from a parameter being a complex type or a macro parameter containing a macro reference. parent - 1 EntityKey with its tag_key populated. context - The value of the offending parameter if it is string-able.", -"An arbitrary HTML tag contains a piece of javascript with too many contiguous non-whitespace characters (e.g. a long array with no spaces between elements or an extremely long variable name).", -"A tag name was used which doesn't exist in the input tag list. parent - 1 EntityKey with tag_key populated. context - The name of the missing tag instance.", -"A tag name was used which doesn't exist in the compiled tag list. This happens if a tag is dependent on another tag, but the other tag has no rules attached to it and is pruned in the compiler. parent - 1 EntityKey with tag_key populated. context - The name of the missing tag instance.", -"A trigger id was used which doesn't exist in the triggers list. parent - 1 EntityKey parent of the unknown trigger. context - The id of the missing trigger instance.", -"A trigger of type custom trigger was created that doesn't include a custom event filter. parent - 1 EntityKey with its trigger_key populated. context - Empty.", -"There are multiple triggers with the same id. parent - N EntityKeys each with their trigger_key populated. context - Empty.", -"There is an unknown or unsupported trigger type. parent - 1 EntityKey with its trigger_key populated. context - The trigger type.", -"A trigger has an invalid parameter. parent - 1 EntityKey with its trigger_key populated. context - The invalid field.", -"There are multiple experiments with the same id. parent - N EntityKeys each with their experiment_key populated. context - Empty.", -"Contents of a pixie tag/macro could not be compiled by Pixie Parser. parent - 1 EntityKey with one of the following populated: tag_key, macro_key. context - Empty.", -"The macro cannot be resolved at server side. parent - 1 EntityKey indicating the entity in which this macro is used. context - The macro name.", -"The trigger cannot be used in blocking predicates (i.e. only All/Some pages triggers work for AMP, NS etc.) parent - 1 EntityKey indicating the tag in which this trigger is used. context - The trigger name.", -"A line in the input text is too long.", -"The value of a SELECT parameter in a vendor template instance does not point to an allowed vendor template instance. For details, see the documentation of the typesInSelect property in a vendor template. parent - 1 EntityKey indicating the tag/macro with this parameter. context - The parameter name.", -"The input container version contains a deprecated GA content experiment macro that needs to be removed.", -"Reminder: new error types will be treated as internal errors and trigger alerts unless they are handled in j/c/g/analytics/containertag/compiler/ErrorReporter.java&l=104 Please also remember to add new error types to CTUI at j/c/g/analytics/containertag/ui/app/components/container/compilererror/ HTML is not sanitized and contains unsafe content.", -"HTML attribute is not sanitized and the value is unsafe.", -"CSS is not sanitized and contains unsafe content.", -"The specified parameter was not found in the referenced entity. parent - 1 EntityKey with tag_key populated. context - The missing parameter in the form of \".\".", -"The custom template has invalid runtime code. parent - Entity key for the custom template. context - The error message.", -"The container version contains a Google tag tag and a destination tag that use the same destination ID. parent - Entity key for the conflicting Google tag. context - The Google tag tag name.", -"The container version has routing destinations, but is missing required activity instances. parent - Empty. context - Empty. proposed_change - The proposed change to add the missing activities.", -"The container version contains a product destination tag with a destination ID value that cannot be resolved statically. parent - Entity key of the destination tag. context - The name of the variable that could not be resolved. If the destination ID was a template value, then this will be the serialized value.", -"The container version contains a product destination tag with a destination ID value that is in an invalid format. parent - Entity key of the destination tag. context - The invalid destination ID.", -"GTM ToS is required for publishing versions with 3P tags. parent - not set context - Empty." -], -"type": "string" -} -}, -"type": "object" -}, "Condition": { "description": "Represents a predicate.", "id": "Condition", @@ -4963,13 +4853,6 @@ "description": "Compiler errors or not.", "type": "boolean" }, -"compilerErrors": { -"description": "Compiler error details.", -"items": { -"$ref": "CompilerErrorLite" -}, -"type": "array" -}, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." @@ -5804,13 +5687,6 @@ "description": "Compiler errors or not.", "type": "boolean" }, -"compilerErrors": { -"description": "Compiler error details.", -"items": { -"$ref": "CompilerErrorLite" -}, -"type": "array" -}, "containerVersion": { "$ref": "ContainerVersion", "description": "The container version created." @@ -5826,13 +5702,6 @@ "description": "Were there compiler errors or not.", "type": "boolean" }, -"compilerErrors": { -"description": "Compiler error details.", -"items": { -"$ref": "CompilerErrorLite" -}, -"type": "array" -}, "containerVersion": { "$ref": "ContainerVersion", "description": "The quick previewed container version." @@ -6595,12 +6464,14 @@ "enum": [ "decimalSeparatorTypeUnspecified", "period", -"comma" +"comma", +"automatic" ], "enumDescriptions": [ "", "The option to convert a variable value to a number with a period as the decimal separator.", -"The option to convert a variable value to a number with a comma as the decimal separator." +"The option to convert a variable value to a number with a comma as the decimal separator.", +"The option to convert a variable value to a number with automatic decimal separator detection." ], "type": "string" }, From d2b1c2d4bc821388646d089fd23587f42195b88f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:07 +0000 Subject: [PATCH 48/50] feat(workstations): update the api #### workstations:v1beta The following keys were added: - resources.projects.resources.locations.resources.workstationClusters.resources.workstationConfigs.resources.workstations.methods.suspend (Total Keys: 12) - schemas.OAuthToken.properties.expiresIn (Total Keys: 2) - schemas.SuspendWorkstationRequest (Total Keys: 3) - schemas.WorkstationConfig.properties.idleAction.type (Total Keys: 1) --- ...orkstationClusters.workstationConfigs.html | 5 ++ ...sters.workstationConfigs.workstations.html | 57 +++++++++++-- .../documents/workstations.v1beta.json | 84 +++++++++++++++++-- 3 files changed, 132 insertions(+), 14 deletions(-) diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 8e37efdc94..a17bbfe670 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -261,6 +261,7 @@

Method Details

"allowedUnauthenticatedCorsPreflightRequests": True or False, # Optional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request. "disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", @@ -519,6 +520,7 @@

Method Details

"allowedUnauthenticatedCorsPreflightRequests": True or False, # Optional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request. "disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", @@ -766,6 +768,7 @@

Method Details

"allowedUnauthenticatedCorsPreflightRequests": True or False, # Optional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request. "disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", @@ -966,6 +969,7 @@

Method Details

"allowedUnauthenticatedCorsPreflightRequests": True or False, # Optional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request. "disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", @@ -1181,6 +1185,7 @@

Method Details

"allowedUnauthenticatedCorsPreflightRequests": True or False, # Optional. By default, the workstations service makes sure that all requests to the workstation are authenticated. CORS preflight requests do not include cookies or custom headers, and so are considered unauthenticated and blocked by the workstations service. Enabling this option allows these unauthenticated CORS preflight requests through to the workstation, where it becomes the responsibility of the destination server in the workstation to validate the request. "disableLocalhostReplacement": True or False, # Optional. By default, the workstations service replaces references to localhost, 127.0.0.1, and 0.0.0.0 with the workstation's hostname in http responses from the workstation so that applications under development run properly on the workstation. This may intefere with some applications, and so this option allows that behavior to be disabled. }, + "idleAction": "A String", # Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP. "idleTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `"7200s"` (2 hours). The default is `"1200s"` (20 minutes). "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. "a_key": "A String", diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 3ff0de0ca4..7a08402f5b 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -119,6 +119,9 @@

Instance Methods

stop(name, body=None, x__xgafv=None)

Stops running a workstation, reducing costs.

+

+ suspend(name, body=None, x__xgafv=None)

+

Suspends a workstation to reduce costs.

testIamPermissions(resource, body=None, x__xgafv=None)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

@@ -717,11 +720,12 @@

Method Details

The object takes the form of: { # Request message for PushCredentials. - "applicationDefaultCredentials": { # OAuth token. # Optional. Credentials used by Cloud Client Libraries, Google API Client Libraries, and other tooling within the user conainer: https://cloud.google.com/docs/authentication/application-default-credentials - "accessToken": "A String", # Required. The OAuth token. - "email": "A String", # Optional. The email address encapsulated in the OAuth token. - "expireTime": "A String", # Optional. The time the OAuth access token will expire. This should be the time the access token was generated plus the expires_in offset returned from the Access Token Response. - "scopes": "A String", # Optional. The scopes encapsulated in the OAuth token. See https://developers.google.com/identity/protocols/oauth2/scopes for more information. + "applicationDefaultCredentials": { # Represents an OAuth 2.0 access token and its associated metadata. # Optional. Credentials used by Cloud Client Libraries, Google API Client Libraries, and other tooling within the user container. For more information, see https://cloud.google.com/docs/authentication/application-default-credentials + "accessToken": "A String", # Required. The OAuth 2.0 access token value. + "email": "A String", # Optional. The email address associated with the OAuth 2.0 access token. + "expireTime": "A String", # Optional. The time the OAuth access token will expire. This should be the time the access token was generated plus the expires_in offset returned from the Access Token Response. Only one of `expire_time` or `expires_in` should be specified. + "expiresIn": "A String", # Optional. The lifetime duration of the access token. Only one of `expire_time` or `expires_in` should be specified. + "scopes": "A String", # Optional. The scopes associated with the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/oauth2/scopes for more information. }, } @@ -926,6 +930,49 @@

Method Details

}
+
+ suspend(name, body=None, x__xgafv=None) +
Suspends a workstation to reduce costs.
+
+Args:
+  name: string, Required. Name of the workstation to suspend. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SuspendWorkstation.
+  "etag": "A String", # Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.
+  "validateOnly": True or False, # Optional. If set, validate the request and preview the result, but do not actually apply it.
+}
+
+  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.
+  },
+}
+
+
testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json
index 35f9dcfa5a..d814a141cd 100644
--- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json
@@ -1143,6 +1143,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"suspend": {
+"description": "Suspends a workstation to reduce costs.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:suspend",
+"httpMethod": "POST",
+"id": "workstations.projects.locations.workstationClusters.workstationConfigs.workstations.suspend",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Name of the workstation to suspend.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/workstationClusters/[^/]+/workstationConfigs/[^/]+/workstations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}:suspend",
+"request": {
+"$ref": "SuspendWorkstationRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "testIamPermissions": {
 "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workstationClusters/{workstationClustersId}/workstationConfigs/{workstationConfigsId}/workstations/{workstationsId}:testIamPermissions",
@@ -1182,7 +1210,7 @@
 }
 }
 },
-"revision": "20260604",
+"revision": "20260705",
 "rootUrl": "https://workstations.googleapis.com/",
 "schemas": {
 "Accelerator": {
@@ -1918,24 +1946,29 @@
 "type": "object"
 },
 "OAuthToken": {
-"description": "OAuth token.",
+"description": "Represents an OAuth 2.0 access token and its associated metadata.",
 "id": "OAuthToken",
 "properties": {
 "accessToken": {
-"description": "Required. The OAuth token.",
+"description": "Required. The OAuth 2.0 access token value.",
 "type": "string"
 },
 "email": {
-"description": "Optional. The email address encapsulated in the OAuth token.",
+"description": "Optional. The email address associated with the OAuth 2.0 access token.",
 "type": "string"
 },
 "expireTime": {
-"description": "Optional. The time the OAuth access token will expire. This should be the time the access token was generated plus the expires_in offset returned from the Access Token Response.",
+"description": "Optional. The time the OAuth access token will expire. This should be the time the access token was generated plus the expires_in offset returned from the Access Token Response. Only one of `expire_time` or `expires_in` should be specified.",
 "format": "google-datetime",
 "type": "string"
 },
+"expiresIn": {
+"description": "Optional. The lifetime duration of the access token. Only one of `expire_time` or `expires_in` should be specified.",
+"format": "google-duration",
+"type": "string"
+},
 "scopes": {
-"description": "Optional. The scopes encapsulated in the OAuth token. See https://developers.google.com/identity/protocols/oauth2/scopes for more information.",
+"description": "Optional. The scopes associated with the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/oauth2/scopes for more information.",
 "type": "string"
 }
 },
@@ -2121,7 +2154,7 @@
 "properties": {
 "applicationDefaultCredentials": {
 "$ref": "OAuthToken",
-"description": "Optional. Credentials used by Cloud Client Libraries, Google API Client Libraries, and other tooling within the user conainer: https://cloud.google.com/docs/authentication/application-default-credentials"
+"description": "Optional. Credentials used by Cloud Client Libraries, Google API Client Libraries, and other tooling within the user container. For more information, see https://cloud.google.com/docs/authentication/application-default-credentials"
 }
 },
 "type": "object"
@@ -2264,6 +2297,21 @@
 },
 "type": "object"
 },
+"SuspendWorkstationRequest": {
+"description": "Request message for SuspendWorkstation.",
+"id": "SuspendWorkstationRequest",
+"properties": {
+"etag": {
+"description": "Optional. If set, the request will be rejected if the latest version of the workstation on the server does not have this ETag.",
+"type": "string"
+},
+"validateOnly": {
+"description": "Optional. If set, validate the request and preview the result, but do not actually apply it.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "TestIamPermissionsRequest": {
 "description": "Request message for `TestIamPermissions` method.",
 "id": "TestIamPermissionsRequest",
@@ -2416,14 +2464,18 @@
 "STATE_STARTING",
 "STATE_RUNNING",
 "STATE_STOPPING",
-"STATE_STOPPED"
+"STATE_STOPPED",
+"STATE_SUSPENDING",
+"STATE_SUSPENDED"
 ],
 "enumDescriptions": [
 "Do not use.",
 "The workstation is not yet ready to accept requests from users but will be soon.",
 "The workstation is ready to accept requests from users.",
 "The workstation is being stopped.",
-"The workstation is stopped and will not be able to receive requests until it is started."
+"The workstation is stopped and will not be able to receive requests until it is started.",
+"The workstation is being suspended.",
+"The workstation is suspended."
 ],
 "readOnly": true,
 "type": "string"
@@ -2673,6 +2725,20 @@
 "$ref": "HttpOptions",
 "description": "Optional. HTTP options that customize the behavior of the workstation service's HTTP proxy."
 },
+"idleAction": {
+"description": "Optional. The action to take when the workstation has been idle for the duration specified in idle_timeout. Defaults to STOP.",
+"enum": [
+"IDLE_ACTION_UNSPECIFIED",
+"STOP",
+"SUSPEND"
+],
+"enumDescriptions": [
+"Defaults to STOP.",
+"Stop the workstation after idle_timeout.",
+"Suspend the workstation after idle_timeout."
+],
+"type": "string"
+},
 "idleTimeout": {
 "description": "Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds\u2014for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).",
 "format": "google-duration",

From a484bbd38ab890712b094c870668c43954e39299 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 14 Jul 2026 07:42:08 +0000
Subject: [PATCH 49/50] feat(youtube): update the api

#### youtube:v3

The following keys were added:
- schemas.BrandPartner (Total Keys: 4)
- schemas.LiveChatMessageDeletedDetails.deprecated (Total Keys: 1)
- schemas.LiveChatMessageRetractedDetails.deprecated (Total Keys: 1)
- schemas.LiveChatMessageSnippet.properties.messageDeletedDetails.deprecated (Total Keys: 1)
- schemas.LiveChatMessageSnippet.properties.messageRetractedDetails.deprecated (Total Keys: 1)
- schemas.Video.properties.brandPartner.$ref (Total Keys: 1)

The following keys were changed:
- resources.playlistImages.methods.insert.mediaUpload.maxSize (Total Keys: 1)
- resources.playlistImages.methods.update.mediaUpload.maxSize (Total Keys: 1)
- resources.thumbnails.methods.set.mediaUpload.maxSize (Total Keys: 1)
---
 docs/dyn/youtube_v3.liveChatMessages.html     | 10 ++--
 docs/dyn/youtube_v3.videos.html               | 20 +++++++
 ...utube_v3.youtube.v3.liveChat.messages.html |  4 +-
 .../discovery_cache/documents/youtube.v3.json | 56 ++++++++++++++++---
 4 files changed, 76 insertions(+), 14 deletions(-)

diff --git a/docs/dyn/youtube_v3.liveChatMessages.html b/docs/dyn/youtube_v3.liveChatMessages.html
index aeadfa4674..c1ec4648b2 100644
--- a/docs/dyn/youtube_v3.liveChatMessages.html
+++ b/docs/dyn/youtube_v3.liveChatMessages.html
@@ -135,7 +135,7 @@ 

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. @@ -250,7 +250,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. @@ -378,7 +378,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. @@ -487,7 +487,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. @@ -640,7 +640,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. diff --git a/docs/dyn/youtube_v3.videos.html b/docs/dyn/youtube_v3.videos.html index 5512192114..e30af4773e 100644 --- a/docs/dyn/youtube_v3.videos.html +++ b/docs/dyn/youtube_v3.videos.html @@ -208,6 +208,10 @@

Method Details

"restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "videoGameRating": "A String", # Video game rating, if any. }, + "brandPartner": { # Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6 + "channelHandle": "A String", # Required. Channel handle, must begin with "@" + "channelId": "A String", # Required. External Channel ID, must begin with "UC" + }, "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. "caption": "A String", # The value of captions indicates whether the video has captions or not. "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. @@ -516,6 +520,10 @@

Method Details

"restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "videoGameRating": "A String", # Video game rating, if any. }, + "brandPartner": { # Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6 + "channelHandle": "A String", # Required. Channel handle, must begin with "@" + "channelId": "A String", # Required. External Channel ID, must begin with "UC" + }, "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. "caption": "A String", # The value of captions indicates whether the video has captions or not. "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. @@ -847,6 +855,10 @@

Method Details

"restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "videoGameRating": "A String", # Video game rating, if any. }, + "brandPartner": { # Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6 + "channelHandle": "A String", # Required. Channel handle, must begin with "@" + "channelId": "A String", # Required. External Channel ID, must begin with "UC" + }, "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. "caption": "A String", # The value of captions indicates whether the video has captions or not. "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. @@ -1218,6 +1230,10 @@

Method Details

"restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "videoGameRating": "A String", # Video game rating, if any. }, + "brandPartner": { # Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6 + "channelHandle": "A String", # Required. Channel handle, must begin with "@" + "channelId": "A String", # Required. External Channel ID, must begin with "UC" + }, "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. "caption": "A String", # The value of captions indicates whether the video has captions or not. "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. @@ -1520,6 +1536,10 @@

Method Details

"restricted": True or False, # Age-restricted trailers. For redband trailers and adult-rated video-games. Only users aged 18+ can view the content. The the field is true the content is restricted to viewers aged 18+. Otherwise The field won't be present. "videoGameRating": "A String", # Video game rating, if any. }, + "brandPartner": { # Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6 + "channelHandle": "A String", # Required. Channel handle, must begin with "@" + "channelId": "A String", # Required. External Channel ID, must begin with "UC" + }, "contentDetails": { # Details about the content of a YouTube Video. # The contentDetails object contains information about the video content, including the length of the video and its aspect ratio. "caption": "A String", # The value of captions indicates whether the video has captions or not. "contentRating": { # Ratings schemes. The country-specific ratings are mostly for movies and shows. LINT.IfChange # Specifies the ratings that the video received under various rating schemes. diff --git a/docs/dyn/youtube_v3.youtube.v3.liveChat.messages.html b/docs/dyn/youtube_v3.youtube.v3.liveChat.messages.html index 490d91db56..5298f30d04 100644 --- a/docs/dyn/youtube_v3.youtube.v3.liveChat.messages.html +++ b/docs/dyn/youtube_v3.youtube.v3.liveChat.messages.html @@ -124,7 +124,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. @@ -233,7 +233,7 @@

Method Details

"id": "A String", # The ID that YouTube assigns to uniquely identify the message. "kind": "youtube#liveChatMessage", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatMessage". "snippet": { # Next ID: 35 # The snippet object contains basic details about the message. - "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll + "authorChannelId": "A String", # The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll "displayMessage": "A String", # Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent. "fanFundingEventDetails": { # Details about the funding event, this is only set if the type is 'fanFundingEvent'. "amountDisplayString": "A String", # A rendered string that displays the fund amount and currency to the user. diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 1a39934643..2e24e85480 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -2250,7 +2250,7 @@ "image/png", "application/octet-stream" ], -"maxSize": "2097152", +"maxSize": "52428800", "protocols": { "resumable": { "multipart": true, @@ -2360,7 +2360,7 @@ "image/png", "application/octet-stream" ], -"maxSize": "2097152", +"maxSize": "52428800", "protocols": { "resumable": { "multipart": true, @@ -3499,7 +3499,7 @@ "image/png", "application/octet-stream" ], -"maxSize": "2097152", +"maxSize": "52428800", "protocols": { "resumable": { "multipart": true, @@ -4192,7 +4192,7 @@ } } }, -"revision": "20260608", +"revision": "20260709", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -4690,6 +4690,21 @@ }, "type": "object" }, +"BrandPartner": { +"description": "Details about the brand partner linked to the video for Creator Initiated Linking (CIL). Next ID: 6", +"id": "BrandPartner", +"properties": { +"channelHandle": { +"description": "Required. Channel handle, must begin with \"@\"", +"type": "string" +}, +"channelId": { +"description": "Required. External Channel ID, must begin with \"UC\"", +"type": "string" +} +}, +"type": "object" +}, "Caption": { "description": "A *caption* resource represents a YouTube caption track. A caption track is associated with exactly one YouTube video.", "id": "Caption", @@ -9041,6 +9056,7 @@ true "type": "object" }, "LiveChatMessageDeletedDetails": { +"deprecated": true, "id": "LiveChatMessageDeletedDetails", "properties": { "deletedMessageId": { @@ -9106,6 +9122,7 @@ true "type": "object" }, "LiveChatMessageRetractedDetails": { +"deprecated": true, "id": "LiveChatMessageRetractedDetails", "properties": { "retractedMessageId": { @@ -9119,7 +9136,7 @@ true "id": "LiveChatMessageSnippet", "properties": { "authorChannelId": { -"description": "The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll", +"description": "The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor memberMilestoneChatEvent - the member that sent the message membershipGiftingEvent - the user that made the purchase giftMembershipReceivedEvent - the user that received the gift membership messageDeletedEvent - the moderator that took the action. Unused. messageRetractedEvent - the author that retracted their message. Unused. userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase superStickerEvent - the user that made the purchase pollEvent - the user that created the poll", "type": "string" }, "displayMessage": { @@ -9155,10 +9172,12 @@ true "description": "Details about the Membership Gifting event, this is only set if the type is 'membershipGiftingEvent'." }, "messageDeletedDetails": { -"$ref": "LiveChatMessageDeletedDetails" +"$ref": "LiveChatMessageDeletedDetails", +"deprecated": true }, "messageRetractedDetails": { -"$ref": "LiveChatMessageRetractedDetails" +"$ref": "LiveChatMessageRetractedDetails", +"deprecated": true }, "newSponsorDetails": { "$ref": "LiveChatNewSponsorDetails", @@ -9207,6 +9226,26 @@ true "pollEvent", "giftEvent" ], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +true, +true, +false, +false, +false, +false, +false +], "enumDescriptions": [ "", "", @@ -11256,6 +11295,9 @@ true "$ref": "VideoAgeGating", "description": "Age restriction details related to a video. This data can only be retrieved by the video owner." }, +"brandPartner": { +"$ref": "BrandPartner" +}, "contentDetails": { "$ref": "VideoContentDetails", "description": "The contentDetails object contains information about the video content, including the length of the video and its aspect ratio." From 6c5ebb5e9815cf48182303be3057593841428f02 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 14 Jul 2026 07:42:09 +0000 Subject: [PATCH 50/50] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...viceprovisioning_v1.customers.devices.html | 2 +- ...androidenterprise_v1.enrollmentTokens.html | 4 +- ...oidmanagement_v1.enterprises.policies.html | 24 +- ...bleadmin_v2.projects.instances.tables.html | 2 +- docs/dyn/blogger_v3.blogUserInfos.html | 2 +- docs/dyn/blogger_v3.blogs.html | 2 +- docs/dyn/blogger_v3.comments.html | 2 +- docs/dyn/blogger_v3.html | 2 +- docs/dyn/blogger_v3.pageViews.html | 2 +- docs/dyn/blogger_v3.pages.html | 2 +- docs/dyn/blogger_v3.postUserInfos.html | 2 +- docs/dyn/blogger_v3.posts.html | 2 +- docs/dyn/blogger_v3.users.html | 2 +- ...agement_v1.customers.connectorConfigs.html | 2 +- ...try_v1alpha.projects.locations.realms.html | 8 +- ...lpha.projects.locations.registryBooks.html | 2 +- ...v1.accountTypes.accounts.partnerLinks.html | 4 +- ...Types.accounts.userListDirectLicenses.html | 2 +- ...Types.accounts.userListGlobalLicenses.html | 2 +- ...es.userListGlobalLicenseCustomerInfos.html | 2 +- ...er_v1.accountTypes.accounts.userLists.html | 2 +- ...ntai_v1.projects.locations.processors.html | 156 +- ...ocations.processors.humanReviewConfig.html | 74 +- ...ocations.processors.processorVersions.html | 166 +- ...ects.locations.schemas.schemaVersions.html | 106 +- ...projects.locations.processors.dataset.html | 102 +- ...v1beta3.projects.locations.processors.html | 226 +- ...ocations.processors.humanReviewConfig.html | 144 +- ...ocations.processors.processorVersions.html | 236 +- ...ects.locations.schemas.schemaVersions.html | 106 +- ...ng_v1beta.projects.locations.backends.html | 8 +- docs/dyn/firebasecrashlytics_v1alpha.html | 111 + ...shlytics_v1alpha.projects.apps.events.html | 595 +++++ ...basecrashlytics_v1alpha.projects.apps.html | 106 + ...shlytics_v1alpha.projects.apps.issues.html | 314 +++ ...cs_v1alpha.projects.apps.issues.notes.html | 191 ++ ...hlytics_v1alpha.projects.apps.reports.html | 381 ++++ ...ashlytics_v1alpha.projects.apps.users.html | 108 + .../firebasecrashlytics_v1alpha.projects.html | 91 + .../iam_v1.projects.serviceAccounts.keys.html | 8 +- ..._v1.accounts.aggregateProductStatuses.html | 6 +- ...eta.accounts.aggregateProductStatuses.html | 6 +- ...nessinformation_v1.accounts.locations.html | 2 +- ...tions.locations.securityProfileGroups.html | 8 +- ...y_v1.projects.locations.authzPolicies.html | 32 +- ...jects.locations.securityProfileGroups.html | 8 +- ...tions.locations.securityProfileGroups.html | 8 +- ...eta1.projects.locations.authzPolicies.html | 32 +- ...jects.locations.securityProfileGroups.html | 8 +- ...ocations.workloadIdentityPools.openid.html | 4 +- ...ions.workloadIdentityPools.well_known.html | 4 +- ...ocations.workloadIdentityPools.openid.html | 4 +- ...ions.workloadIdentityPools.well_known.html | 4 +- .../documents/accessapproval.v1.json | 8 +- .../documents/alertcenter.v1beta1.json | 8 +- .../androiddeviceprovisioning.v1.json | 4 +- .../documents/androidenterprise.v1.json | 4 +- .../documents/androidmanagement.v1.json | 14 +- .../documents/bigtableadmin.v2.json | 4 +- .../documents/binaryauthorization.v1.json | 8 +- .../binaryauthorization.v1beta1.json | 8 +- .../discovery_cache/documents/blogger.v3.json | 4 +- .../documents/chromemanagement.v1.json | 13 +- .../cloudnumberregistry.v1alpha.json | 4 +- .../documents/containeranalysis.v1.json | 8 +- .../documents/containeranalysis.v1alpha1.json | 8 +- .../documents/containeranalysis.v1beta1.json | 8 +- .../documents/databasecenter.v1beta.json | 38 +- .../documents/datamanager.v1.json | 20 +- .../documents/documentai.v1.json | 80 +- .../documents/documentai.v1beta3.json | 78 +- .../documents/firebaseapphosting.v1beta.json | 4 +- .../firebasecrashlytics.v1alpha.json | 1936 +++++++++++++++++ .../discovery_cache/documents/gkehub.v1.json | 4 +- .../documents/gkehub.v1alpha.json | 4 +- .../documents/gkehub.v1beta.json | 4 +- .../discovery_cache/documents/iam.v1.json | 4 +- .../merchantapi.issueresolution_v1.json | 6 +- .../merchantapi.issueresolution_v1beta.json | 6 +- .../documents/monitoring.v1.json | 10 +- .../mybusinessbusinessinformation.v1.json | 4 +- .../networkconnectivity.v1alpha1.json | 10 +- .../documents/networksecurity.v1.json | 8 +- .../documents/networksecurity.v1beta1.json | 8 +- .../documents/ondemandscanning.v1.json | 8 +- .../documents/ondemandscanning.v1beta1.json | 8 +- .../discovery_cache/documents/redis.v1.json | 18 +- .../documents/redis.v1beta1.json | 18 +- .../discovery_cache/documents/sts.v1.json | 10 +- 89 files changed, 4855 insertions(+), 963 deletions(-) create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.notes.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.apps.users.html create mode 100644 docs/dyn/firebasecrashlytics_v1alpha.projects.html create mode 100644 googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json diff --git a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html index b15fd3de08..c211e7b498 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html +++ b/docs/dyn/androiddeviceprovisioning_v1.customers.devices.html @@ -194,7 +194,7 @@

Method Details

Args: parent: string, Required. The customer managing the devices. An API resource name in the format `customers/[CUSTOMER_ID]`. (required) - pageSize: string, Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. + pageSize: string, Optional. The maximum number of devices to show in a page of results. If unset or 0, defaults to 1000. If a value greater than 1000 is specified, it will be coerced to 1000. pageToken: string, A token specifying which result page to return. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/androidenterprise_v1.enrollmentTokens.html b/docs/dyn/androidenterprise_v1.enrollmentTokens.html index 08abd7037c..3d49087c21 100644 --- a/docs/dyn/androidenterprise_v1.enrollmentTokens.html +++ b/docs/dyn/androidenterprise_v1.enrollmentTokens.html @@ -96,7 +96,7 @@

Method Details

The object takes the form of: { # A token used to enroll a device. - "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. + "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. In the JSON REST API, this is represented as a string (e.g., `3600s`). "enrollmentTokenType": "A String", # [Required] The type of the enrollment token. "googleAuthenticationOptions": { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment. "authenticationRequirement": "A String", # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token. @@ -114,7 +114,7 @@

Method Details

An object of the form: { # A token used to enroll a device. - "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. + "duration": "A String", # [Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. In the JSON REST API, this is represented as a string (e.g., `3600s`). "enrollmentTokenType": "A String", # [Required] The type of the enrollment token. "googleAuthenticationOptions": { # Options for Google authentication during the enrollment. # [Optional] Provides options related to Google authentication during the enrollment. "authenticationRequirement": "A String", # [Optional] Specifies whether user should authenticate with Google during enrollment. This setting, if specified,`GoogleAuthenticationSettings` specified for the enterprise resource is ignored for devices enrolled with this token. diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index f2db499b44..b8f37ed104 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -280,7 +280,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -493,7 +493,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", @@ -808,7 +808,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -1021,7 +1021,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", @@ -1422,7 +1422,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -1635,7 +1635,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", @@ -1941,7 +1941,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -2154,7 +2154,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", @@ -2458,7 +2458,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -2671,7 +2671,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", @@ -2991,7 +2991,7 @@

Method Details

}, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. - "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. + "defaultApplicationSettings": [ # Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details. { # The default application setting for a DefaultApplicationType. "defaultApplicationScopes": [ # Required. The scopes to which the policy should be applied. This list must not be empty or contain duplicates.A NonComplianceDetail with MANAGEMENT_MODE reason and DEFAULT_APPLICATION_SETTING_UNSUPPORTED_SCOPES specific reason is reported if none of the specified scopes can be applied to the management mode (e.g. a fully managed device receives a policy with only SCOPE_PERSONAL_PROFILE in the list). "A String", @@ -3204,7 +3204,7 @@

Method Details

"A String", ], }, - "persistentPreferredActivities": [ # Default intent handler activities. + "persistentPreferredActivities": [ # Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior. { # A default activity for handling intents that match a particular intent filter. Note: To set up a kiosk, use InstallType to KIOSK rather than use persistent preferred activities. "actions": [ # The intent actions to match in the filter. If any actions are included in the filter, then an intent's action must be one of those values for it to match. If no actions are included, the intent action is ignored. "A String", diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 52018bcb2f..aadf3474d9 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -1963,7 +1963,7 @@

Method Details

} ignoreWarnings: boolean, Optional. If true, ignore safety checks when updating the table. - updateMask: string, Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. + updateMask: string, Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `automated_backup_policy.locations` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/blogger_v3.blogUserInfos.html b/docs/dyn/blogger_v3.blogUserInfos.html index 0ae0d2a9ef..ae83467953 100644 --- a/docs/dyn/blogger_v3.blogUserInfos.html +++ b/docs/dyn/blogger_v3.blogUserInfos.html @@ -72,7 +72,7 @@ -

blogger API . blogUserInfos

+

Blogger API . blogUserInfos

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.blogs.html b/docs/dyn/blogger_v3.blogs.html index 00783a7f28..2652132339 100644 --- a/docs/dyn/blogger_v3.blogs.html +++ b/docs/dyn/blogger_v3.blogs.html @@ -72,7 +72,7 @@ -

blogger API . blogs

+

Blogger API . blogs

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.comments.html b/docs/dyn/blogger_v3.comments.html index 0759b2a0ec..880f66cf76 100644 --- a/docs/dyn/blogger_v3.comments.html +++ b/docs/dyn/blogger_v3.comments.html @@ -72,7 +72,7 @@ -

blogger API . comments

+

Blogger API . comments

Instance Methods

approve(blogId, postId, commentId, x__xgafv=None)

diff --git a/docs/dyn/blogger_v3.html b/docs/dyn/blogger_v3.html index 7fa99faec2..9f14da132f 100644 --- a/docs/dyn/blogger_v3.html +++ b/docs/dyn/blogger_v3.html @@ -72,7 +72,7 @@ -

blogger API

+

Blogger API

Instance Methods

blogUserInfos() diff --git a/docs/dyn/blogger_v3.pageViews.html b/docs/dyn/blogger_v3.pageViews.html index bf73a5e101..81fc3cd4dd 100644 --- a/docs/dyn/blogger_v3.pageViews.html +++ b/docs/dyn/blogger_v3.pageViews.html @@ -72,7 +72,7 @@ -

blogger API . pageViews

+

Blogger API . pageViews

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.pages.html b/docs/dyn/blogger_v3.pages.html index 306cd8055c..6ee70433c0 100644 --- a/docs/dyn/blogger_v3.pages.html +++ b/docs/dyn/blogger_v3.pages.html @@ -72,7 +72,7 @@ -

blogger API . pages

+

Blogger API . pages

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.postUserInfos.html b/docs/dyn/blogger_v3.postUserInfos.html index bea92d50de..3a32ba2537 100644 --- a/docs/dyn/blogger_v3.postUserInfos.html +++ b/docs/dyn/blogger_v3.postUserInfos.html @@ -72,7 +72,7 @@ -

blogger API . postUserInfos

+

Blogger API . postUserInfos

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.posts.html b/docs/dyn/blogger_v3.posts.html index 44b7c59757..ffd9d2ccf1 100644 --- a/docs/dyn/blogger_v3.posts.html +++ b/docs/dyn/blogger_v3.posts.html @@ -72,7 +72,7 @@ -

blogger API . posts

+

Blogger API . posts

Instance Methods

close()

diff --git a/docs/dyn/blogger_v3.users.html b/docs/dyn/blogger_v3.users.html index ebbe88e38b..f92fa607c9 100644 --- a/docs/dyn/blogger_v3.users.html +++ b/docs/dyn/blogger_v3.users.html @@ -72,7 +72,7 @@ -

blogger API . users

+

Blogger API . users

Instance Methods

close()

diff --git a/docs/dyn/chromemanagement_v1.customers.connectorConfigs.html b/docs/dyn/chromemanagement_v1.customers.connectorConfigs.html index aac27ca060..9daa66f295 100644 --- a/docs/dyn/chromemanagement_v1.customers.connectorConfigs.html +++ b/docs/dyn/chromemanagement_v1.customers.connectorConfigs.html @@ -244,7 +244,7 @@

Method Details

"type": "A String", # Required. The type of the connector. } - connectorConfigId: string, Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-63 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID. + connectorConfigId: string, Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-36 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html index b1f2917c41..3e172a88ed 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html @@ -130,7 +130,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "managementType": "A String", # Required. Management type of the Realm. + "managementType": "A String", # Optional. Management type of the Realm. "name": "A String", # Required. Identifier. The resource name of the Realm. "registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm. "trafficType": "A String", # Required. Traffic type of the Realm. @@ -245,7 +245,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "managementType": "A String", # Required. Management type of the Realm. + "managementType": "A String", # Optional. Management type of the Realm. "name": "A String", # Required. Identifier. The resource name of the Realm. "registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm. "trafficType": "A String", # Required. Traffic type of the Realm. @@ -300,7 +300,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "managementType": "A String", # Required. Management type of the Realm. + "managementType": "A String", # Optional. Management type of the Realm. "name": "A String", # Required. Identifier. The resource name of the Realm. "registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm. "trafficType": "A String", # Required. Traffic type of the Realm. @@ -356,7 +356,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "managementType": "A String", # Required. Management type of the Realm. + "managementType": "A String", # Optional. Management type of the Realm. "name": "A String", # Required. Identifier. The resource name of the Realm. "registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm. "trafficType": "A String", # Required. Traffic type of the Realm. diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html index 6df505d02c..888b1f92fb 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html @@ -538,7 +538,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "managementType": "A String", # Required. Management type of the Realm. + "managementType": "A String", # Optional. Management type of the Realm. "name": "A String", # Required. Identifier. The resource name of the Realm. "registryBook": "A String", # Required. Name of the RegistryBook that claims the Realm. "trafficType": "A String", # Required. Traffic type of the Realm. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html index df93600994..cf2c76a847 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html @@ -197,8 +197,8 @@

Method Details

Args: parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` - pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100. + filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321` + pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100. pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html index 2fb0be417d..bc7e688939 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListDirectLicenses.html @@ -260,7 +260,7 @@

Method Details

Args: parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html index 6420db3fee..c53771e3fe 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.html @@ -259,7 +259,7 @@

Method Details

Args: parent: string, Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID} (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListGlobalLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html index 1e3ff953fe..243ee1a357 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.html @@ -95,7 +95,7 @@

Method Details

Args: parent: string, Required. The global license whose customer info are being queried. Should be in the format `accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}`. To list all global license customer info under an account, replace the user list global license id with a '-' (for example, `accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-`) (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` + filter: string, Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time` pageSize: integer, Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserListDirectLicense` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserListDirectLicense` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html index e3aa98cc3a..de339763dc 100644 --- a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html +++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html @@ -328,7 +328,7 @@

Method Details

Args: parent: string, Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account} (required) - filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types` + filter: string, Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = "list 1"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(display_name, "name1", "name2")` Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types` pageSize: integer, Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. pageToken: string, Optional. A page token, received from a previous `ListUserLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLists` must match the call that provided the page token. x__xgafv: string, V1 error format. diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html index 5e1521c916..8cb3e43734 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.html @@ -195,7 +195,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -207,7 +207,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -274,7 +274,7 @@

Method Details

The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -302,7 +302,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -454,7 +454,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -494,7 +494,7 @@

Method Details

"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -547,9 +547,9 @@

Method Details

}, "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -563,9 +563,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -628,9 +628,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -745,7 +745,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -776,10 +776,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -800,7 +800,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -855,7 +855,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -886,10 +886,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -923,10 +923,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1004,10 +1004,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1129,10 +1129,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1227,10 +1227,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1277,10 +1277,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1291,10 +1291,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1461,10 +1461,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1513,10 +1513,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1603,13 +1603,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1631,10 +1631,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1733,7 +1733,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1745,7 +1745,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1783,9 +1783,9 @@

Method Details

{ # Response message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, will populate fields based on the processor's behavior. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1799,9 +1799,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -1864,9 +1864,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1981,7 +1981,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2012,10 +2012,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2036,7 +2036,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -2091,7 +2091,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2122,10 +2122,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2159,10 +2159,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2240,10 +2240,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2365,10 +2365,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2463,10 +2463,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2513,10 +2513,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2527,10 +2527,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2697,10 +2697,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2749,10 +2749,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2839,13 +2839,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -2867,10 +2867,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html index 75c3165a5a..10ec25a51d 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html @@ -99,7 +99,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # The document schema of the human review task. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -111,7 +111,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -132,9 +132,9 @@

Method Details

}, "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -148,9 +148,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -213,9 +213,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -330,7 +330,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -361,10 +361,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -385,7 +385,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -440,7 +440,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -471,10 +471,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -508,10 +508,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -589,10 +589,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -714,10 +714,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -812,10 +812,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -862,10 +862,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -876,10 +876,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1046,10 +1046,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1098,10 +1098,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1188,13 +1188,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1216,10 +1216,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index 147fc68f6f..e390c00fea 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -190,7 +190,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -202,7 +202,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -413,7 +413,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -425,7 +425,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -524,7 +524,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -536,7 +536,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -639,9 +639,9 @@

Method Details

}, "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -655,9 +655,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -720,9 +720,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -837,7 +837,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -868,10 +868,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -892,7 +892,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -947,7 +947,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -978,10 +978,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1015,10 +1015,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1096,10 +1096,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1221,10 +1221,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1319,10 +1319,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1369,10 +1369,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1383,10 +1383,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1553,10 +1553,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1605,10 +1605,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1695,13 +1695,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1723,10 +1723,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1825,7 +1825,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1837,7 +1837,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1875,9 +1875,9 @@

Method Details

{ # Response message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, will populate fields based on the processor's behavior. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1891,9 +1891,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -1956,9 +1956,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -2073,7 +2073,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2104,10 +2104,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2128,7 +2128,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -2183,7 +2183,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2214,10 +2214,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2251,10 +2251,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2332,10 +2332,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2457,10 +2457,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2555,10 +2555,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2605,10 +2605,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2619,10 +2619,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2789,10 +2789,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2841,10 +2841,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2931,13 +2931,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -2959,10 +2959,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3042,7 +3042,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. The schema the processor version will be trained with. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -3054,7 +3054,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -3075,7 +3075,7 @@

Method Details

}, "foundationModelTuningOptions": { # Options to control foundation model tuning of the processor. # Options to control foundation model tuning of a processor. "learningRateMultiplier": 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. - "previousFineTunedProcessorVersionName": "A String", # Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + "previousFineTunedProcessorVersionName": "A String", # Optional. Resource name of a previously fine tuned version ID to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. "trainSteps": 42, # Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. }, "inputData": { # The input data used to train a new ProcessorVersion. # Optional. The input data used to train the ProcessorVersion. @@ -3116,7 +3116,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -3128,7 +3128,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. diff --git a/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html index a278e4c7f2..ce1e1c4250 100644 --- a/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html @@ -123,7 +123,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -135,7 +135,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -174,7 +174,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -186,7 +186,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -279,7 +279,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -291,7 +291,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -321,7 +321,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -333,7 +333,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -362,9 +362,9 @@

Method Details

"inlineDocuments": { # A set of inline documents. # The set of documents specified inline. For each document, its `uri` or `content` field must be set. "documents": [ # The list of documents. { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -378,9 +378,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -443,9 +443,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -560,7 +560,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -591,10 +591,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -615,7 +615,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -670,7 +670,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -701,10 +701,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -738,10 +738,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -819,10 +819,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -944,10 +944,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1042,10 +1042,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1092,10 +1092,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1106,10 +1106,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1276,10 +1276,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1328,10 +1328,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1418,13 +1418,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1446,10 +1446,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1536,7 +1536,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1548,7 +1548,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1595,7 +1595,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1607,7 +1607,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1658,7 +1658,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1670,7 +1670,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1727,7 +1727,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1739,7 +1739,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. @@ -1779,7 +1779,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1791,7 +1791,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "displayName": "A String", # User defined name for the property. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html index 3f86379596..452ff6a0b1 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html @@ -114,8 +114,8 @@

Method Details

"individualDocumentIds": { # List of individual DocumentIds. # Document identifiers. "documentIds": [ # Required. List of Document IDs indicating where the actual documents are stored. { # Document Identifier. - "gcsManagedDocId": { # Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. # A document id within user-managed Cloud Storage. - "cwDocId": "A String", # Id of the document (indexed) managed by Content Warehouse. + "gcsManagedDocId": { # Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. # A document ID within user-managed Cloud Storage. + "cwDocId": "A String", # ID of the document (indexed) managed by Content Warehouse. "gcsUri": "A String", # Required. The Cloud Storage URI where the actual document is stored. }, "revisionRef": { # The revision reference specifies which revision on the document to read. # Points to a specific revision of the document if set. @@ -123,8 +123,8 @@

Method Details

"revisionCase": "A String", # Reads the revision by the predefined case. "revisionId": "A String", # Reads the revision given by the id. }, - "unmanagedDocId": { # Identifies a document uniquely within the scope of a dataset in unmanaged option. # A document id within unmanaged dataset. - "docId": "A String", # Required. The id of the document. + "unmanagedDocId": { # Identifies a document uniquely within the scope of a dataset in unmanaged option. # A document ID within unmanaged dataset. + "docId": "A String", # Required. The ID of the document. }, }, ], @@ -185,7 +185,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. Schema of the dataset. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -201,7 +201,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -242,7 +242,7 @@

Method Details

Args: dataset: string, Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset (required) - documentId_gcsManagedDocId_cwDocId: string, Id of the document (indexed) managed by Content Warehouse. + documentId_gcsManagedDocId_cwDocId: string, ID of the document (indexed) managed by Content Warehouse. documentId_gcsManagedDocId_gcsUri: string, Required. The Cloud Storage URI where the actual document is stored. documentId_revisionRef_latestProcessorVersion: string, Reads the revision generated by the processor version. The format takes the full resource name of processor version. `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}` documentId_revisionRef_revisionCase: string, Reads the revision by the predefined case. @@ -252,7 +252,7 @@

Method Details

LATEST_TIMESTAMP - The latest revision based on timestamp. BASE_OCR_REVISION - The first (OCR) revision. documentId_revisionRef_revisionId: string, Reads the revision given by the id. - documentId_unmanagedDocId_docId: string, Required. The id of the document. + documentId_unmanagedDocId_docId: string, Required. The ID of the document. pageRange_end: integer, Last page number (one-based index) to be returned. pageRange_start: integer, First page number (one-based index) to be returned. readMask: string, If set, only fields listed here will be returned. Otherwise, all fields will be returned by default. @@ -266,9 +266,9 @@

Method Details

{ "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -282,9 +282,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -347,9 +347,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -464,7 +464,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -495,10 +495,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -519,7 +519,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -574,7 +574,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -605,10 +605,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -642,10 +642,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -723,10 +723,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -848,10 +848,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -946,10 +946,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -996,10 +996,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1010,10 +1010,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1180,10 +1180,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1232,10 +1232,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1322,13 +1322,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1350,10 +1350,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1505,8 +1505,8 @@

Method Details

"datasetType": "A String", # Type of the dataset split to which the document belongs. "displayName": "A String", # The display name of the document. "documentId": { # Document Identifier. # Document identifier. - "gcsManagedDocId": { # Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. # A document id within user-managed Cloud Storage. - "cwDocId": "A String", # Id of the document (indexed) managed by Content Warehouse. + "gcsManagedDocId": { # Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option. # A document ID within user-managed Cloud Storage. + "cwDocId": "A String", # ID of the document (indexed) managed by Content Warehouse. "gcsUri": "A String", # Required. The Cloud Storage URI where the actual document is stored. }, "revisionRef": { # The revision reference specifies which revision on the document to read. # Points to a specific revision of the document if set. @@ -1514,8 +1514,8 @@

Method Details

"revisionCase": "A String", # Reads the revision by the predefined case. "revisionId": "A String", # Reads the revision given by the id. }, - "unmanagedDocId": { # Identifies a document uniquely within the scope of a dataset in unmanaged option. # A document id within unmanaged dataset. - "docId": "A String", # Required. The id of the document. + "unmanagedDocId": { # Identifies a document uniquely within the scope of a dataset in unmanaged option. # A document ID within unmanaged dataset. + "docId": "A String", # Required. The ID of the document. }, }, "labelingState": "A String", # Labeling state of the document. @@ -1554,7 +1554,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. Schema of the dataset. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1570,7 +1570,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1617,7 +1617,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. Schema of the dataset. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1633,7 +1633,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html index 9e41db579b..a07c05bb88 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html @@ -217,7 +217,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -233,7 +233,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -310,7 +310,7 @@

Method Details

The object takes the form of: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -338,7 +338,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -490,7 +490,7 @@

Method Details

An object of the form: { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -530,7 +530,7 @@

Method Details

"nextPageToken": "A String", # Points to the next processor, otherwise empty. "processors": [ # The list of processors. { # The first-class citizen for Document AI. Each processor defines how to extract structural information from a document. - "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version} + "activeSchemaVersion": "A String", # Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}. "createTime": "A String", # Output only. The time the processor was created. "defaultProcessorVersion": "A String", # The default processor version. "displayName": "A String", # The display name of the processor. @@ -577,9 +577,9 @@

Method Details

{ # Request message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, the content and mime_type fields must be set. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -593,9 +593,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -658,9 +658,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -775,7 +775,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -806,10 +806,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -830,7 +830,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -885,7 +885,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -916,10 +916,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -953,10 +953,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1034,10 +1034,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1159,10 +1159,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1257,10 +1257,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1307,10 +1307,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1321,10 +1321,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1491,10 +1491,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1543,10 +1543,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1633,13 +1633,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1661,10 +1661,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1726,9 +1726,9 @@

Method Details

}, "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1742,9 +1742,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -1807,9 +1807,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1924,7 +1924,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1955,10 +1955,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1979,7 +1979,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -2034,7 +2034,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2065,10 +2065,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2102,10 +2102,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2183,10 +2183,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2308,10 +2308,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2406,10 +2406,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2456,10 +2456,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2470,10 +2470,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2640,10 +2640,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2692,10 +2692,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2782,13 +2782,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -2810,10 +2810,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2917,7 +2917,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -2933,7 +2933,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -2981,9 +2981,9 @@

Method Details

{ # Response message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, will populate fields based on the processor's behavior. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -2997,9 +2997,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -3062,9 +3062,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -3179,7 +3179,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3210,10 +3210,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3234,7 +3234,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -3289,7 +3289,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3320,10 +3320,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3357,10 +3357,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3438,10 +3438,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3563,10 +3563,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3661,10 +3661,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3711,10 +3711,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3725,10 +3725,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3895,10 +3895,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3947,10 +3947,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -4037,13 +4037,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -4065,10 +4065,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html index ffdf4d0e61..047c7a01de 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html @@ -97,9 +97,9 @@

Method Details

{ # Request message for the ReviewDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document that needs human review. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -113,9 +113,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -178,9 +178,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -295,7 +295,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -326,10 +326,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -350,7 +350,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -405,7 +405,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -436,10 +436,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -473,10 +473,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -554,10 +554,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -679,10 +679,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -777,10 +777,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -827,10 +827,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -841,10 +841,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1011,10 +1011,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1063,10 +1063,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1153,13 +1153,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1181,10 +1181,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1242,7 +1242,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # The document schema of the human review task. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1258,7 +1258,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1289,9 +1289,9 @@

Method Details

}, "enableSchemaValidation": True or False, # Whether the validation should be performed on the ad-hoc review request. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1305,9 +1305,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -1370,9 +1370,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1487,7 +1487,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1518,10 +1518,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1542,7 +1542,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -1597,7 +1597,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1628,10 +1628,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1665,10 +1665,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1746,10 +1746,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1871,10 +1871,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1969,10 +1969,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2019,10 +2019,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2033,10 +2033,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2203,10 +2203,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2255,10 +2255,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2345,13 +2345,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -2373,10 +2373,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index e2ce40fa07..c9a89adafc 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -207,7 +207,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -223,7 +223,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -444,7 +444,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -460,7 +460,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -615,7 +615,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -631,7 +631,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -738,9 +738,9 @@

Method Details

{ # Request message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, the content and mime_type fields must be set. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -754,9 +754,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -819,9 +819,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -936,7 +936,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -967,10 +967,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -991,7 +991,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -1046,7 +1046,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -1077,10 +1077,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1114,10 +1114,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1195,10 +1195,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1320,10 +1320,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1418,10 +1418,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1468,10 +1468,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1482,10 +1482,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1652,10 +1652,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1704,10 +1704,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1794,13 +1794,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1822,10 +1822,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1887,9 +1887,9 @@

Method Details

}, "imagelessMode": True or False, # Optional. Option to remove images from the document. "inlineDocument": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # An inline document proto. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -1903,9 +1903,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -1968,9 +1968,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -2085,7 +2085,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2116,10 +2116,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2140,7 +2140,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -2195,7 +2195,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -2226,10 +2226,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2263,10 +2263,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2344,10 +2344,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2469,10 +2469,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2567,10 +2567,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2617,10 +2617,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2631,10 +2631,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2801,10 +2801,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2853,10 +2853,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -2943,13 +2943,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -2971,10 +2971,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3078,7 +3078,7 @@

Method Details

"schemaOverride": { # The schema defines the output of the processed document by a processor. # Optional. Override the schema of the ProcessorVersion. Will return an Invalid Argument error if this field is set when the underlying ProcessorVersion doesn't support schema override. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -3094,7 +3094,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -3142,9 +3142,9 @@

Method Details

{ # Response message for the ProcessDocument method. "document": { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. # The document payload, will populate fields based on the processor's behavior. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -3158,9 +3158,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -3223,9 +3223,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -3340,7 +3340,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3371,10 +3371,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3395,7 +3395,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -3450,7 +3450,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -3481,10 +3481,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3518,10 +3518,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3599,10 +3599,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3724,10 +3724,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3822,10 +3822,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3872,10 +3872,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -3886,10 +3886,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -4056,10 +4056,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -4108,10 +4108,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -4198,13 +4198,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -4226,10 +4226,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -4310,7 +4310,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Optional. The schema the processor version will be trained with. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -4326,7 +4326,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -4357,7 +4357,7 @@

Method Details

}, "foundationModelTuningOptions": { # Options to control foundation model tuning of the processor. # Options to control foundation model tuning of a processor. "learningRateMultiplier": 3.14, # Optional. The multiplier to apply to the recommended learning rate. Valid values are between 0.1 and 10. If not provided, recommended learning rate will be used. - "previousFineTunedProcessorVersionName": "A String", # Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. + "previousFineTunedProcessorVersionName": "A String", # Optional. Resource name of a previously fine tuned version ID to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`. "trainSteps": 42, # Optional. The number of steps to run for model tuning. Valid values are between 1 and 400. If not provided, recommended steps will be used. }, "inputData": { # The input data used to train a new ProcessorVersion. # Optional. The input data used to train the ProcessorVersion. @@ -4398,7 +4398,7 @@

Method Details

"documentSchema": { # The schema defines the output of the processed document by a processor. # Output only. The schema of the processor version. Describes the output. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -4414,7 +4414,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html index 4a5b66b0ea..fe6e5a34b2 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html @@ -123,7 +123,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -139,7 +139,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -188,7 +188,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -204,7 +204,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -307,7 +307,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -323,7 +323,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -363,7 +363,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -379,7 +379,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -418,9 +418,9 @@

Method Details

"inlineDocuments": { # A set of inline documents. # The set of documents specified inline. For each document, its `uri` or `content` field must be set. "documents": [ # The list of documents. { # Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. - "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id. + "blobAssets": [ # Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. { # Represents a blob asset. It's used to store the content of the inline blob in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID. - "assetId": "A String", # Optional. The id of the blob asset. + "assetId": "A String", # Optional. The ID of the blob asset. "content": "A String", # Optional. The content of the blob asset, for example, image bytes. "mimeType": "A String", # The mime type of the blob asset. An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -434,9 +434,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image chunk field. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. }, "tableChunkField": { # The table chunk field in the chunk. # The table chunk field in the chunk. "annotations": { # Represents the annotation of a block or a chunk. # Annotation of the table chunk field. @@ -499,9 +499,9 @@

Method Details

"annotations": { # Represents the annotation of a block or a chunk. # Annotation of the image block. "description": "A String", # The description of the content with this annotation. }, - "blobAssetId": "A String", # Optional. Asset id of the inline image. If set, find the image content in the blob_assets field. - "dataUri": "A String", # Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, - "gcsUri": "A String", # Optional. Google Cloud Storage uri of the image. + "blobAssetId": "A String", # Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field. + "dataUri": "A String", # Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:, + "gcsUri": "A String", # Optional. Google Cloud Storage URI of the image. "imageText": "A String", # Text extracted from the image using OCR or alt text describing the image. "mimeType": "A String", # Mime type of the image. An IANA published [media type (MIME type)] (https://www.iana.org/assignments/media-types/media-types.xhtml). }, @@ -616,7 +616,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -647,10 +647,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -671,7 +671,7 @@

Method Details

"type": "A String", # Required. Entity type from a schema, for example, `Address`. }, ], - "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. + "entitiesRevisionId": "A String", # The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision. "entitiesRevisions": [ # A list of entity revisions. The entity revisions are appended to the document in the processing order. This field can be used for comparing the entity extraction results at different stages of the processing. { # Entity revision. "entities": [ # The entities in this revision. @@ -726,7 +726,7 @@

Method Details

"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "signatureValue": True or False, # A signature - a graphical representation of a person's name, often used to sign a document. + "signatureValue": True or False, # A signature, which is a graphical representation of a person's name, often used to sign a document. "text": "A String", # Optional. An optional field to store a normalized string. For some entity types, one of respective `structured_value` fields may also be populated. Also not all the types of `structured_value` will be normalized. For example, some processors may not generate `float` or `integer` normalized text by default. Below are sample formats mapped to structured values. - Money/Currency type (`money_value`) is in the ISO 4217 text format. - Date type (`date_value`) is in the ISO 8601 text format. - Datetime type (`datetime_value`) is in the ISO 8601 text format. }, "pageAnchor": { # Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. # Optional. Represents the provenance of this entity wrt. the location on the page where it was found. @@ -757,10 +757,10 @@

Method Details

# Object with schema name: GoogleCloudDocumentaiV1beta3DocumentEntity ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -794,10 +794,10 @@

Method Details

], }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # Optional. The history of this revision. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -875,10 +875,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1000,10 +1000,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1098,10 +1098,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1148,10 +1148,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1162,10 +1162,10 @@

Method Details

}, ], "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this page. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1332,10 +1332,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this table. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1384,10 +1384,10 @@

Method Details

}, }, "provenance": { # Structure to identify provenance relationships between annotations in different revisions. # The history of this annotation. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1474,13 +1474,13 @@

Method Details

], "revisions": [ # Placeholder. Revision history of this document. { # Contains past or forward revisions of this document. - "agent": "A String", # If the change was made by a person specify the name or id of that person. + "agent": "A String", # If the change was made by a person specify the name or ID of that person. "createTime": "A String", # The time that the revision was created, internally generated by doc proto storage at the time of create. "humanReview": { # Human Review information of the document. # Human Review information of this revision. "state": "A String", # Human review state. For example, `requested`, `succeeded`, `rejected`. "stateMessage": "A String", # A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. }, - "id": "A String", # Id of the revision, internally generated by doc proto storage. Unique within the context of the document. + "id": "A String", # ID of the revision, internally generated by doc proto storage. Unique within the context of the document. "parent": [ # The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. 42, ], @@ -1502,10 +1502,10 @@

Method Details

"changedText": "A String", # The text that replaces the text identified in the `text_anchor`. "provenance": [ # The history of this annotation. { # Structure to identify provenance relationships between annotations in different revisions. - "id": 42, # The Id of this operation. Needs to be unique within the scope of the revision. + "id": 42, # The ID of this operation. Needs to be unique within the scope of the revision. "parents": [ # References to the original elements that are replaced. { # The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - "id": 42, # The id of the parent provenance. + "id": 42, # The ID of the parent provenance. "index": 42, # The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. "revision": 42, # The index of the index into current revision's parent_ids list. }, @@ -1592,7 +1592,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1608,7 +1608,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1665,7 +1665,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1681,7 +1681,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1742,7 +1742,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1758,7 +1758,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1825,7 +1825,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1841,7 +1841,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. @@ -1891,7 +1891,7 @@

Method Details

"schema": { # The schema defines the output of the processed document by a processor. # Required. The schema of the SchemaVersion. "description": "A String", # Description of the schema. "displayName": "A String", # Display name to show users. - "documentPrompt": "A String", # Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. + "documentPrompt": "A String", # Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing. "entityTypes": [ # Entity types of the schema. { # EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors. Multiple types can also compose a dependency tree to represent nested types. "baseTypes": [ # The entity type that this type is derived from. For now, one and only one should be set. @@ -1907,7 +1907,7 @@

Method Details

"A String", ], }, - "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. + "name": "A String", # Name of the type. It must be unique within the schema file and cannot be a "Common Type". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility. "properties": [ # Description the nested structure, or composition of an entity. { # Defines properties that can be part of the entity type. "description": "A String", # The description of the property. Could be used to provide more information about the property for model calls. diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html index efc5165513..3f5f62325c 100644 --- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html +++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html @@ -171,7 +171,7 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. - "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. See [Firebase documentation](https://firebase.google.com/docs/app-hosting/frameworks-tooling#managing_runtime_versions) for more details. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. "value": "A String", # Optional. The value of the runtime. }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -307,7 +307,7 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. - "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. See [Firebase documentation](https://firebase.google.com/docs/app-hosting/frameworks-tooling#managing_runtime_versions) for more details. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. "value": "A String", # Optional. The value of the runtime. }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -380,7 +380,7 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. - "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. See [Firebase documentation](https://firebase.google.com/docs/app-hosting/frameworks-tooling#managing_runtime_versions) for more details. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. "value": "A String", # Optional. The value of the runtime. }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. @@ -461,7 +461,7 @@

Method Details

], "reconciling": True or False, # Output only. A field that, if true, indicates that the system is working to make adjustments to the backend during a LRO. "requestLogsDisabled": True or False, # Optional. A field that, if true, indicates that incoming request logs are disabled for this backend. Incoming request logs are enabled by default. - "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. + "runtime": { # Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime "nodejs" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. See [Firebase documentation](https://firebase.google.com/docs/app-hosting/frameworks-tooling#managing_runtime_versions) for more details. # Optional. The runtime that the backend will be built on. A default base_image will be chosen for a given runtime. "value": "A String", # Optional. The value of the runtime. }, "serviceAccount": "A String", # Required. The name of the service account used for Cloud Build and Cloud Run. Should have the role roles/firebaseapphosting.computeRunner or equivalent permissions. diff --git a/docs/dyn/firebasecrashlytics_v1alpha.html b/docs/dyn/firebasecrashlytics_v1alpha.html new file mode 100644 index 0000000000..07924ae8cb --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.html @@ -0,0 +1,111 @@ + + + +

Firebase Crashlytics API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request()

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request() +
Create a BatchHttpRequest object based on the discovery document.
+
+                Args:
+                  callback: callable, A callback to be called for each response, of the
+                    form callback(id, response, exception). The first parameter is the
+                    request id, and the second is the deserialized response object. The
+                    third is an apiclient.errors.HttpError exception object if an HTTP
+                    error occurred while processing the request, or None if no error
+                    occurred.
+
+                Returns:
+                  A BatchHttpRequest object based on the discovery document.
+                
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html new file mode 100644 index 0000000000..ad9281460a --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html @@ -0,0 +1,595 @@ + + + +

Firebase Crashlytics API . projects . apps . events

+

Instance Methods

+

+ batchGet(parent, names=None, readMask=None, x__xgafv=None)

+

Fetch a batch of up to 100 events by name.

+

+ close()

+

Close httplib2 connections.

+

+ list(parent, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)

+

List the events for an issue matching filter criteria, sorted in descending order by timestamp.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ batchGet(parent, names=None, readMask=None, x__xgafv=None) +
Fetch a batch of up to 100 events by name.
+
+Args:
+  parent: string, Required. The firebase application. Format: "projects/{project}/apps/{app_id}". (required)
+  names: string, Required. The resource names of the desired events. A maximum of 100 events can be retrieved in a batch. Format: "projects/{project}/apps/{app_id}/events/{event_id}". The app_id and event_id are required, but project may be "-" to conserve space in long URIs. (repeated)
+  readMask: string, Optional. The list of Event fields to include in the response. If omitted, the full event is returned.
+  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 the BatchGetEvents method.
+  "events": [ # The list of retrieved events.
+    { # The message describing a single Crashlytics event. Related to BigQuery export schema, which can be found at [Export Crashlytics data to BigQuery](https://firebase.google.com/docs/crashlytics/bigquery-export#dataset-schema-crashlytics)
+      "appOrientation": "A String", # App orientation at the time of the crash (portrait or landscape).
+      "blameFrame": { # A frame in a stacktrace. # The stack trace frame blamed by Crashlytics processing. May not be present in future analyzer.
+        "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+        "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+        "column": "A String", # The column on the line.
+        "file": "A String", # The name of the source file in which the frame is found.
+        "library": "A String", # The display name of the library that includes the frame.
+        "line": "A String", # The line number in the file of the frame.
+        "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+        "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+        "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+      },
+      "breadcrumbs": [ # Analytics events recorded by the analytics SDK during the session.
+        { # Analytics events recorded during the session.
+          "eventTime": "A String", # Device timestamp for the event.
+          "params": { # Event parameters.
+            "a_key": "A String",
+          },
+          "title": "A String", # Analytic event name.
+        },
+      ],
+      "browser": { # Web browser metadata. # Browser and version.
+        "browser": "A String", # Browser name.
+        "displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
+        "displayVersion": "A String", # Browser display version number.
+      },
+      "buildStamp": "A String", # Metadata provided by the app's build system, including version control repository info.
+      "bundleOrPackage": "A String", # The bundle name for iOS apps or the package name of Android apps. Format: "com.mycompany.myapp".
+      "crashlyticsSdkVersion": "A String", # Crashlytics SDK version.
+      "customKeys": { # Custom keys set by the developer during the session.
+        "a_key": "A String",
+      },
+      "device": { # Mobile device metadata. # Mobile device metadata.
+        "architecture": "A String", # Device processor architecture.
+        "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
+        "displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
+        "formFactor": "A String", # See FormFactor message.
+        "manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
+        "marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
+        "model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
+      },
+      "deviceOrientation": "A String", # Device orientation at the time of the crash (portrait or landscape).
+      "errors": [ # Apple only. A non-fatal error captured by the iOS SDK and its stacktrace.
+        { # A non-fatal error and its stacktrace, only from Apple apps.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that the stacktrace in this error is where the fault occurred.
+          "code": "A String", # Error code associated with the app's custom logged NSError.
+          "frames": [ # The frames in the error's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "queue": "A String", # The queue on which the thread was running.
+          "subtitle": "A String", # The subtitle of the error.
+          "title": "A String", # The title of the error.
+        },
+      ],
+      "eventId": "A String", # Output only. Immutable. The unique event identifier is assigned during processing.
+      "eventTime": "A String", # Device timestamp that the event was recorded.
+      "exceptions": [ # Android and web only. Exceptions that occurred during this event. Nested exceptions are presented in reverse chronological order, so that the last record is the first exception thrown.
+        { # A Java or Javascript exception and its stacktrace. Only from Android or web apps.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that this thread is where the fault occurred.
+          "exceptionMessage": "A String", # A message associated with the exception.
+          "frames": [ # The frames in the exception's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "nested": True or False, # True for all but the last-thrown exception (i.e. the first record).
+          "subtitle": "A String", # The subtitle of the exception.
+          "title": "A String", # The title of the exception.
+          "type": "A String", # The exception type e.g. java.lang.IllegalStateException.
+        },
+      ],
+      "installationUuid": "A String", # Unique identifier for the device-app installation. This field is used to compute the unique number of impacted users.
+      "issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Details for the [Issue] assigned to this [Event].
+        "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+        "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+        "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+        "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+        "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+        "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+        "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+        "notesCount": "A String", # Output only. The number of notes attached to an issue.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+        "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+          { # Distinctive characteristics assigned by the Crashlytics analyzer.
+            "description": "A String", # Output only. Supporting detail information.
+            "signal": "A String", # Output only. The signal name.
+          },
+        ],
+        "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+        "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+        "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+        "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+        "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+        "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+          { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+            "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+            "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+          },
+        ],
+      },
+      "issueSubtitle": "A String", # The subtitle of the issue in which the event was grouped. This is usually a symbol or an exception message.
+      "issueTitle": "A String", # The title of the issue in which the event was grouped. This is usually a source file or method name.
+      "issueVariant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Details for the [IssueVariant] assigned to this [Event].
+        "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+        "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+      },
+      "logs": [ # Log messages recorded by the developer during the session.
+        { # Developer-provided log lines recorded during the session.
+          "logTime": "A String", # Device timestamp when the line was logged.
+          "message": "A String", # Log message.
+        },
+      ],
+      "memory": { # Mobile device memory usage. # Mobile device memory usage.
+        "free": "A String", # Bytes free.
+        "used": "A String", # Bytes in use.
+      },
+      "name": "A String", # Required. Output only. Immutable. Identifier. The name of the event resource. Format: "projects/{project}/apps/{app_id}/events/{event}".
+      "operatingSystem": { # Mobile device operating system metadata. # Operating system and version.
+        "deviceType": "A String", # The device category (mobile, tablet, desktop).
+        "displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
+        "displayVersion": "A String", # Operating system display version number.
+        "modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
+        "os": "A String", # Operating system name.
+        "type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
+      },
+      "platform": "A String", # ANDROID, IOS, or WEB.
+      "processState": "A String", # The state of the app process at the time of the event.
+      "receivedTime": "A String", # Server timestamp that the event was received by Crashlytics.
+      "routePath": "A String", # Output only. Web only. The route path of the web application when the event occurred, excluding query parameters and fragment.
+      "sessionId": "A String", # Unique identifier for the Firebase session.
+      "storage": { # Mobile device disk/flash usage. Not reported for all devices. # Mobile device disk/flash usage.
+        "free": "A String", # Bytes free.
+        "used": "A String", # Bytes used.
+      },
+      "threads": [ # Application threads present at the time the event was recorded. Each contains a stacktrace. One thread will be blamed for the error.
+        { # An application thread.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that the stacktrace in this thread is where the fault occurred.
+          "crashAddress": "A String", # The address of the signal that caused the application to crash. Only present on crashed native threads.
+          "crashed": True or False, # True when the thread has crashed.
+          "frames": [ # The frames in the thread's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "name": "A String", # The name of the thread.
+          "queue": "A String", # The queue on which the thread was running.
+          "signal": "A String", # The name of the signal that caused the app to crash. Only present on crashed native threads.
+          "signalCode": "A String", # The code of the signal that caused the app to crash. Only present on crashed native threads.
+          "subtitle": "A String", # The subtitle of the thread.
+          "sysThreadId": "A String", # The system id of the thread, only available for ANR threads.
+          "threadId": "A String", # The id of the thread, only available for ANR threads.
+          "threadState": "A String", # Output only. The state of the thread at the time the ANR occurred.
+          "title": "A String", # The title of the thread.
+        },
+      ],
+      "user": { # Developer-provided end user identifiers. # End user identifiers for the device owner.
+        "id": "A String", # User id if provided by the app developer.
+      },
+      "version": { # Application software version. # Mobile application version.
+        "buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
+        "displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
+        "displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
+        "tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
+          { # Describes a release track in the Play Developer Console.
+            "title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
+            "type": "A String", # The type of track (prod, internal, etc...).
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
List the events for an issue matching filter criteria, sorted in descending order by timestamp.
+
+Args:
+  parent: string, Required. The Firebase application. Format: "projects/{project}/apps/{app_id}". (required)
+  filter_browser_displayNames: string, Optional. Only count events from the given browser. This string matches Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or just "name" for all possible versions, e.g. simply "Chrome". (repeated)
+  filter_device_displayNames: string, Only counts events from the given Device model. This string matches Device.display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "manufacturer" for all possible models, e.g. simply "Google". Note that a device's marketing_name field can not be used for filtering. (repeated)
+  filter_device_formFactors: string, Only counts events from devices with the given form factor (e.g. phone or tablet). (repeated)
+    Allowed values
+      FORM_FACTOR_UNSPECIFIED - Unknown.
+      PHONE - Includes mobile phones, small foldables and other form factors not fitting the other categories.
+      TABLET - Includes tablets and larger foldables.
+      DESKTOP - Includes desktops, laptops, Chromebooks, etc.
+      TV - Includes televisions and set-tops.
+      WATCH - Includes both watches and other wearables.
+  filter_interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  filter_interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  filter_issue_content: string, Optional. A space separated list of filter terms matched against the contents of the issue. Contents include the title and the stack trace. Matches must begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet' but not 'myutil.SortedArray'. The filter matches if all filter terms match. All non-alphanumeric characters are ignored for matching. Filtering is assumed to be prefix-search and order-independent unless phrases are surrounded by "". Any terms contained in quotes are searched using exact-match (given filter term "foo", we will not return "foobar"), and must appear in the order given exactly. To get order-dependence but prefix-search, use a * within the quotes ("abc foo*" will match "abc foobar", but not "foo abc" "abcd foobar", or "abc xyz foobar").
+  filter_issue_errorTypes: string, Optional. Only counts events of the given error types. This field matches [Issue.error_type]. (repeated)
+    Allowed values
+      ERROR_TYPE_UNSPECIFIED - Unknown.
+      FATAL - Fatal crash event.
+      NON_FATAL - Non-fatal event, such as a caught Java exception or NSError on iOS.
+      ANR - Application not responding error, Android only.
+  filter_issue_id: string, Optional. Only counts events in the given issue ID. This field matches [Issue.id].
+  filter_issue_signals: string, Optional. Only returns issues currently marked with the given signals. This field matches [Issue.signals.signal]. (repeated)
+    Allowed values
+      SIGNAL_UNSPECIFIED - Default.
+      SIGNAL_EARLY - Indicates an issue that is impacting end users early in the app session.
+      SIGNAL_FRESH - Indicates newly detected issues.
+      SIGNAL_REGRESSED - Indicates previously closed issues which have been detected again.
+      SIGNAL_REPETITIVE - Indicates issues impacting some end users multiple times.
+  filter_issue_state: string, Optional. Deprecated: Prefer `states` field. Only includes events for issues with the given issue state. Only available for `topIssues` reports.
+    Allowed values
+      STATE_UNSPECIFIED - Unknown.
+      OPEN - Ongoing issue.
+      CLOSED - Issue resolved.
+      MUTED - Issue muted. No alerts will be fired for this issue.
+  filter_issue_states: string, Optional. Only includes events for issues with the given issue states. Only available for `topIssues` reports. (repeated)
+    Allowed values
+      STATE_UNSPECIFIED - Unknown.
+      OPEN - Ongoing issue.
+      CLOSED - Issue resolved.
+      MUTED - Issue muted. No alerts will be fired for this issue.
+  filter_issue_variantId: string, Optional. Only counts events for the given issue variant ID. This field matches [IssueVariant.id].
+  filter_operatingSystem_displayNames: string, Only counts events in the given operating system and version. This string matches OperatingSystem.display_name. Format: "osName (osVersion)" e.g. "Android (11)". or just "osName" for all versions, e.g. simply "iPadOS". (repeated)
+  filter_version_displayNames: string, Only counts events in the given app version. This string matches Version.display_name. Format: "display_version (build_version)" e.g. "1.2.3 (456)". (repeated)
+  pageSize: integer, Optional. The maximum number of events per page. If omitted, defaults to 10.
+  pageToken: string, Optional. A page token, received from a previous calls.
+  readMask: string, Optional. The list of Event fields to include in the response. If omitted, the full event is returned.
+  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 the ListEvents method.
+  "events": [ # Returns one element per event, in descending order the by event timestamp.
+    { # The message describing a single Crashlytics event. Related to BigQuery export schema, which can be found at [Export Crashlytics data to BigQuery](https://firebase.google.com/docs/crashlytics/bigquery-export#dataset-schema-crashlytics)
+      "appOrientation": "A String", # App orientation at the time of the crash (portrait or landscape).
+      "blameFrame": { # A frame in a stacktrace. # The stack trace frame blamed by Crashlytics processing. May not be present in future analyzer.
+        "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+        "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+        "column": "A String", # The column on the line.
+        "file": "A String", # The name of the source file in which the frame is found.
+        "library": "A String", # The display name of the library that includes the frame.
+        "line": "A String", # The line number in the file of the frame.
+        "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+        "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+        "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+      },
+      "breadcrumbs": [ # Analytics events recorded by the analytics SDK during the session.
+        { # Analytics events recorded during the session.
+          "eventTime": "A String", # Device timestamp for the event.
+          "params": { # Event parameters.
+            "a_key": "A String",
+          },
+          "title": "A String", # Analytic event name.
+        },
+      ],
+      "browser": { # Web browser metadata. # Browser and version.
+        "browser": "A String", # Browser name.
+        "displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
+        "displayVersion": "A String", # Browser display version number.
+      },
+      "buildStamp": "A String", # Metadata provided by the app's build system, including version control repository info.
+      "bundleOrPackage": "A String", # The bundle name for iOS apps or the package name of Android apps. Format: "com.mycompany.myapp".
+      "crashlyticsSdkVersion": "A String", # Crashlytics SDK version.
+      "customKeys": { # Custom keys set by the developer during the session.
+        "a_key": "A String",
+      },
+      "device": { # Mobile device metadata. # Mobile device metadata.
+        "architecture": "A String", # Device processor architecture.
+        "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
+        "displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
+        "formFactor": "A String", # See FormFactor message.
+        "manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
+        "marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
+        "model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
+      },
+      "deviceOrientation": "A String", # Device orientation at the time of the crash (portrait or landscape).
+      "errors": [ # Apple only. A non-fatal error captured by the iOS SDK and its stacktrace.
+        { # A non-fatal error and its stacktrace, only from Apple apps.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that the stacktrace in this error is where the fault occurred.
+          "code": "A String", # Error code associated with the app's custom logged NSError.
+          "frames": [ # The frames in the error's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "queue": "A String", # The queue on which the thread was running.
+          "subtitle": "A String", # The subtitle of the error.
+          "title": "A String", # The title of the error.
+        },
+      ],
+      "eventId": "A String", # Output only. Immutable. The unique event identifier is assigned during processing.
+      "eventTime": "A String", # Device timestamp that the event was recorded.
+      "exceptions": [ # Android and web only. Exceptions that occurred during this event. Nested exceptions are presented in reverse chronological order, so that the last record is the first exception thrown.
+        { # A Java or Javascript exception and its stacktrace. Only from Android or web apps.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that this thread is where the fault occurred.
+          "exceptionMessage": "A String", # A message associated with the exception.
+          "frames": [ # The frames in the exception's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "nested": True or False, # True for all but the last-thrown exception (i.e. the first record).
+          "subtitle": "A String", # The subtitle of the exception.
+          "title": "A String", # The title of the exception.
+          "type": "A String", # The exception type e.g. java.lang.IllegalStateException.
+        },
+      ],
+      "installationUuid": "A String", # Unique identifier for the device-app installation. This field is used to compute the unique number of impacted users.
+      "issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Details for the [Issue] assigned to this [Event].
+        "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+        "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+        "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+        "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+        "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+        "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+        "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+        "notesCount": "A String", # Output only. The number of notes attached to an issue.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+        "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+          { # Distinctive characteristics assigned by the Crashlytics analyzer.
+            "description": "A String", # Output only. Supporting detail information.
+            "signal": "A String", # Output only. The signal name.
+          },
+        ],
+        "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+        "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+        "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+        "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+        "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+        "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+          { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+            "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+            "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+          },
+        ],
+      },
+      "issueSubtitle": "A String", # The subtitle of the issue in which the event was grouped. This is usually a symbol or an exception message.
+      "issueTitle": "A String", # The title of the issue in which the event was grouped. This is usually a source file or method name.
+      "issueVariant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Details for the [IssueVariant] assigned to this [Event].
+        "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+        "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+      },
+      "logs": [ # Log messages recorded by the developer during the session.
+        { # Developer-provided log lines recorded during the session.
+          "logTime": "A String", # Device timestamp when the line was logged.
+          "message": "A String", # Log message.
+        },
+      ],
+      "memory": { # Mobile device memory usage. # Mobile device memory usage.
+        "free": "A String", # Bytes free.
+        "used": "A String", # Bytes in use.
+      },
+      "name": "A String", # Required. Output only. Immutable. Identifier. The name of the event resource. Format: "projects/{project}/apps/{app_id}/events/{event}".
+      "operatingSystem": { # Mobile device operating system metadata. # Operating system and version.
+        "deviceType": "A String", # The device category (mobile, tablet, desktop).
+        "displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
+        "displayVersion": "A String", # Operating system display version number.
+        "modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
+        "os": "A String", # Operating system name.
+        "type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
+      },
+      "platform": "A String", # ANDROID, IOS, or WEB.
+      "processState": "A String", # The state of the app process at the time of the event.
+      "receivedTime": "A String", # Server timestamp that the event was received by Crashlytics.
+      "routePath": "A String", # Output only. Web only. The route path of the web application when the event occurred, excluding query parameters and fragment.
+      "sessionId": "A String", # Unique identifier for the Firebase session.
+      "storage": { # Mobile device disk/flash usage. Not reported for all devices. # Mobile device disk/flash usage.
+        "free": "A String", # Bytes free.
+        "used": "A String", # Bytes used.
+      },
+      "threads": [ # Application threads present at the time the event was recorded. Each contains a stacktrace. One thread will be blamed for the error.
+        { # An application thread.
+          "blamed": True or False, # True when the Crashlytics analysis has determined that the stacktrace in this thread is where the fault occurred.
+          "crashAddress": "A String", # The address of the signal that caused the application to crash. Only present on crashed native threads.
+          "crashed": True or False, # True when the thread has crashed.
+          "frames": [ # The frames in the thread's stacktrace.
+            { # A frame in a stacktrace.
+              "address": "A String", # The address in the binary image which contains the code. Present for native frames.
+              "blamed": True or False, # True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.
+              "column": "A String", # The column on the line.
+              "file": "A String", # The name of the source file in which the frame is found.
+              "library": "A String", # The display name of the library that includes the frame.
+              "line": "A String", # The line number in the file of the frame.
+              "offset": "A String", # The byte offset into the binary image that contains the code. Present for native frames.
+              "owner": "A String", # One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.
+              "symbol": "A String", # The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.
+            },
+          ],
+          "name": "A String", # The name of the thread.
+          "queue": "A String", # The queue on which the thread was running.
+          "signal": "A String", # The name of the signal that caused the app to crash. Only present on crashed native threads.
+          "signalCode": "A String", # The code of the signal that caused the app to crash. Only present on crashed native threads.
+          "subtitle": "A String", # The subtitle of the thread.
+          "sysThreadId": "A String", # The system id of the thread, only available for ANR threads.
+          "threadId": "A String", # The id of the thread, only available for ANR threads.
+          "threadState": "A String", # Output only. The state of the thread at the time the ANR occurred.
+          "title": "A String", # The title of the thread.
+        },
+      ],
+      "user": { # Developer-provided end user identifiers. # End user identifiers for the device owner.
+        "id": "A String", # User id if provided by the app developer.
+      },
+      "version": { # Application software version. # Mobile application version.
+        "buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
+        "displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
+        "displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
+        "tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
+          { # Describes a release track in the Play Developer Console.
+            "title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
+            "type": "A String", # The type of track (prod, internal, etc...).
+          },
+        ],
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A pagination token to retrieve the next page of events. The next page will have earlier or later events depending on the request's ordering. If this field is not present, there are no subsequent events.
+}
+
+ +
+ 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.html new file mode 100644 index 0000000000..daa0dd68ac --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.html @@ -0,0 +1,106 @@ + + + +

Firebase Crashlytics API . projects . apps

+

Instance Methods

+

+ events() +

+

Returns the events Resource.

+ +

+ issues() +

+

Returns the issues Resource.

+ +

+ reports() +

+

Returns the reports Resource.

+ +

+ users() +

+

Returns the users Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.html new file mode 100644 index 0000000000..017df6d95a --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.html @@ -0,0 +1,314 @@ + + + +

Firebase Crashlytics API . projects . apps . issues

+

Instance Methods

+

+ notes() +

+

Returns the notes Resource.

+ +

+ batchUpdate(parent, body=None, x__xgafv=None)

+

Change the state of a group of issues. This method is not atomic, so partial failures can occur. In the event of a partial failure, the request will fail and you will need to call `GetIssue` to see which issues were not updated.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieve an issue.

+

+ patch(name, body=None, updateMask=None, x__xgafv=None)

+

Change the state of an issue.

+

Method Details

+
+ batchUpdate(parent, body=None, x__xgafv=None) +
Change the state of a group of issues. This method is not atomic, so partial failures can occur. In the event of a partial failure, the request will fail and you will need to call `GetIssue` to see which issues were not updated.
+
+Args:
+  parent: string, Required. The parent resource shared by all issues being updated. Format: projects/{project}/apps/{app}. If this is set, the parent field in the UpdateIssueRequest messages must either be empty or match this field. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the BatchUpdateIssues method.
+  "requests": [ # Required. The request message specifying the resources to update. A maximum of 100 issues can be modified in a batch.
+    { # Request message for the UpdateIssue method.
+      "issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Required. The issue to update. The issue's `name` field is used to identify the issue to update. Format: "projects/{project}/apps/{app}/issues/{issue}".
+        "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+        "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+        "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+        "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+        "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+        "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+        "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+        "notesCount": "A String", # Output only. The number of notes attached to an issue.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+        "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+          { # Distinctive characteristics assigned by the Crashlytics analyzer.
+            "description": "A String", # Output only. Supporting detail information.
+            "signal": "A String", # Output only. The signal name.
+          },
+        ],
+        "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+        "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+        "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+        "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+        "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+        "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+          { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+            "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+            "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+          },
+        ],
+      },
+      "updateMask": "A String", # Optional. The list of Issue fields to update. Currently only "state" is mutable.
+    },
+  ],
+  "updateMask": "A String", # Optional. The list of Issue fields to update. If this is set, the update_mask field in the UpdateIssueRequest messages must either be empty or match this field.
+}
+
+  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 the BatchUpdateIssues method.
+  "issues": [ # Issues updated in the same order as in BatchUpdateIssuesRequest.
+    { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread.
+      "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+      "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+      "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+      "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+      "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+      "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+      "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+      "notesCount": "A String", # Output only. The number of notes attached to an issue.
+      "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+      "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+        { # Distinctive characteristics assigned by the Crashlytics analyzer.
+          "description": "A String", # Output only. Supporting detail information.
+          "signal": "A String", # Output only. The signal name.
+        },
+      ],
+      "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+      "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+      "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+      "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+      "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+      "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+        { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+          "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+          "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+          "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+        },
+      ],
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieve an issue.
+
+Args:
+  name: string, Required. The name of the issue to retrieve. Format: "projects/{project}/apps/{app}/issues/{issue}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread.
+  "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+  "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+  "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+  "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+  "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+  "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+  "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+  "notesCount": "A String", # Output only. The number of notes attached to an issue.
+  "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+  "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+    { # Distinctive characteristics assigned by the Crashlytics analyzer.
+      "description": "A String", # Output only. Supporting detail information.
+      "signal": "A String", # Output only. The signal name.
+    },
+  ],
+  "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+  "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+  "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+  "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+  "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+  "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+    { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+      "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+      "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+      "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+    },
+  ],
+}
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Change the state of an issue.
+
+Args:
+  name: string, Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread.
+  "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+  "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+  "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+  "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+  "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+  "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+  "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+  "notesCount": "A String", # Output only. The number of notes attached to an issue.
+  "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+  "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+    { # Distinctive characteristics assigned by the Crashlytics analyzer.
+      "description": "A String", # Output only. Supporting detail information.
+      "signal": "A String", # Output only. The signal name.
+    },
+  ],
+  "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+  "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+  "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+  "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+  "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+  "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+    { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+      "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+      "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+      "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+    },
+  ],
+}
+
+  updateMask: string, Optional. The list of Issue fields to update. Currently only "state" is mutable.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread.
+  "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+  "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+  "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+  "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+  "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+  "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+  "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+  "notesCount": "A String", # Output only. The number of notes attached to an issue.
+  "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+  "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+    { # Distinctive characteristics assigned by the Crashlytics analyzer.
+      "description": "A String", # Output only. Supporting detail information.
+      "signal": "A String", # Output only. The signal name.
+    },
+  ],
+  "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+  "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+  "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+  "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+  "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+  "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+    { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+      "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+      "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+      "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.notes.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.notes.html new file mode 100644 index 0000000000..76dc929bd7 --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.issues.notes.html @@ -0,0 +1,191 @@ + + + +

Firebase Crashlytics API . projects . apps . issues . notes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(parent, body=None, x__xgafv=None)

+

Create a new note for an issue.

+

+ delete(name, x__xgafv=None)

+

Delete a note by its name.

+

+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)

+

List all notes for a certain issue, sorted in descending order by timestamp.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Create a new note for an issue.
+
+Args:
+  parent: string, Required. The parent resource where this note will be created. Format: "projects/{project}/apps/{app}/issues/{issue}". (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Developer notes for an issue.
+  "author": "A String", # Output only. The email of the author of the note.
+  "body": "A String", # Immutable. The body of the note.
+  "createTime": "A String", # Output only. Time when the note was created.
+  "name": "A String", # Output only. Identifier. Format: "projects/{project}/apps/app/issues/{issue}/notes/{note}".
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Developer notes for an issue.
+  "author": "A String", # Output only. The email of the author of the note.
+  "body": "A String", # Immutable. The body of the note.
+  "createTime": "A String", # Output only. Time when the note was created.
+  "name": "A String", # Output only. Identifier. Format: "projects/{project}/apps/app/issues/{issue}/notes/{note}".
+}
+
+ +
+ delete(name, x__xgafv=None) +
Delete a note by its name.
+
+Args:
+  name: string, Required. The name of the note to delete. Format: projects/{project}/apps/{app}/issues/{issue}/notes/{note}. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # 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); }
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List all notes for a certain issue, sorted in descending order by timestamp.
+
+Args:
+  parent: string, Required. The issue the notes belongs to. Format: "projects/{project}/apps/{app}/issues/{issue}". (required)
+  pageSize: integer, Optional. The maximum number of notes per page. If omitted, defaults to 10.
+  pageToken: string, Optional. A page token, received from a previous calls.
+  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 the ListNotes method.
+  "nextPageToken": "A String", # A pagination token to retrieve the next page of notes. If this field is not present, there are no subsequent notes.
+  "notes": [ # Returns notes ordered descending by the timestamp.
+    { # Developer notes for an issue.
+      "author": "A String", # Output only. The email of the author of the note.
+      "body": "A String", # Immutable. The body of the note.
+      "createTime": "A String", # Output only. Time when the note was created.
+      "name": "A String", # Output only. Identifier. Format: "projects/{project}/apps/app/issues/{issue}/notes/{note}".
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html new file mode 100644 index 0000000000..814bac921a --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html @@ -0,0 +1,381 @@ + + + +

Firebase Crashlytics API . projects . apps . reports

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Get a report with its computed results.

+

+ get_next()

+

Retrieves the next page of results.

+

+ list(parent, x__xgafv=None)

+

List all of the available reports.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, pageSize=None, pageToken=None, x__xgafv=None) +
Get a report with its computed results.
+
+Args:
+  name: string, Required. The report name. Format: "projects/{project}/apps/{app_id}/reports/{report}". (required)
+  filter_browser_displayNames: string, Optional. Only count events from the given browser. This string matches Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or just "name" for all possible versions, e.g. simply "Chrome". (repeated)
+  filter_device_displayNames: string, Only counts events from the given Device model. This string matches Device.display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "manufacturer" for all possible models, e.g. simply "Google". Note that a device's marketing_name field can not be used for filtering. (repeated)
+  filter_device_formFactors: string, Only counts events from devices with the given form factor (e.g. phone or tablet). (repeated)
+    Allowed values
+      FORM_FACTOR_UNSPECIFIED - Unknown.
+      PHONE - Includes mobile phones, small foldables and other form factors not fitting the other categories.
+      TABLET - Includes tablets and larger foldables.
+      DESKTOP - Includes desktops, laptops, Chromebooks, etc.
+      TV - Includes televisions and set-tops.
+      WATCH - Includes both watches and other wearables.
+  filter_interval_endTime: string, Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+  filter_interval_startTime: string, Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+  filter_issue_content: string, Optional. A space separated list of filter terms matched against the contents of the issue. Contents include the title and the stack trace. Matches must begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet' but not 'myutil.SortedArray'. The filter matches if all filter terms match. All non-alphanumeric characters are ignored for matching. Filtering is assumed to be prefix-search and order-independent unless phrases are surrounded by "". Any terms contained in quotes are searched using exact-match (given filter term "foo", we will not return "foobar"), and must appear in the order given exactly. To get order-dependence but prefix-search, use a * within the quotes ("abc foo*" will match "abc foobar", but not "foo abc" "abcd foobar", or "abc xyz foobar").
+  filter_issue_errorTypes: string, Optional. Only counts events of the given error types. This field matches [Issue.error_type]. (repeated)
+    Allowed values
+      ERROR_TYPE_UNSPECIFIED - Unknown.
+      FATAL - Fatal crash event.
+      NON_FATAL - Non-fatal event, such as a caught Java exception or NSError on iOS.
+      ANR - Application not responding error, Android only.
+  filter_issue_id: string, Optional. Only counts events in the given issue ID. This field matches [Issue.id].
+  filter_issue_signals: string, Optional. Only returns issues currently marked with the given signals. This field matches [Issue.signals.signal]. (repeated)
+    Allowed values
+      SIGNAL_UNSPECIFIED - Default.
+      SIGNAL_EARLY - Indicates an issue that is impacting end users early in the app session.
+      SIGNAL_FRESH - Indicates newly detected issues.
+      SIGNAL_REGRESSED - Indicates previously closed issues which have been detected again.
+      SIGNAL_REPETITIVE - Indicates issues impacting some end users multiple times.
+  filter_issue_state: string, Optional. Deprecated: Prefer `states` field. Only includes events for issues with the given issue state. Only available for `topIssues` reports.
+    Allowed values
+      STATE_UNSPECIFIED - Unknown.
+      OPEN - Ongoing issue.
+      CLOSED - Issue resolved.
+      MUTED - Issue muted. No alerts will be fired for this issue.
+  filter_issue_states: string, Optional. Only includes events for issues with the given issue states. Only available for `topIssues` reports. (repeated)
+    Allowed values
+      STATE_UNSPECIFIED - Unknown.
+      OPEN - Ongoing issue.
+      CLOSED - Issue resolved.
+      MUTED - Issue muted. No alerts will be fired for this issue.
+  filter_issue_variantId: string, Optional. Only counts events for the given issue variant ID. This field matches [IssueVariant.id].
+  filter_operatingSystem_displayNames: string, Only counts events in the given operating system and version. This string matches OperatingSystem.display_name. Format: "osName (osVersion)" e.g. "Android (11)". or just "osName" for all versions, e.g. simply "iPadOS". (repeated)
+  filter_version_displayNames: string, Only counts events in the given app version. This string matches Version.display_name. Format: "display_version (build_version)" e.g. "1.2.3 (456)". (repeated)
+  granularity: string, Optional. The report response will contain one data point per time grain. If omitted, the report will contain a single data point for the complete interval.
+    Allowed values
+      TIME_GRANULARITY_UNSPECIFIED - Unknown.
+      TIME_GRANULARITY_NONE - Returns a single interval for the requested time range.
+      TIME_GRANULARITY_HOUR - Hour.
+      TIME_GRANULARITY_DAY - Day.
+  pageSize: integer, Optional. The maximum number of result groups to return. If omitted, defaults to 25.
+  pageToken: string, Optional. A page token, received from a previous call. The page token is only valid for the exact same set of filters, which must also be sent in subsequent requests. This token is valid for 10 minutes after the first request.
+  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 the GetReport method. A report consists of the results of a query over an application's events. The events may be filtered by various criteria defined in the filters proto. The result will consist of a number of paginated groups, of a type relevant to the report such as issues or device models.
+  "displayName": "A String", # Output only. The displayable title of the report.
+  "groups": [ # Aggregate event statistics in the report will be grouped by a dimension, such as by issue or by version. The response contains one element per group, and all ReportGroup messages will have the same parent field.
+    { # A group of results in an EventReport. In any report, the group_parent field is strictly the same type for all of the groups in any collection.
+      "browser": { # Web browser metadata. # Browser metrics group.
+        "browser": "A String", # Browser name.
+        "displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
+        "displayVersion": "A String", # Browser display version number.
+      },
+      "device": { # Mobile device metadata. # Device metrics group.
+        "architecture": "A String", # Device processor architecture.
+        "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
+        "displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
+        "formFactor": "A String", # See FormFactor message.
+        "manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
+        "marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
+        "model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
+      },
+      "issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Issue metrics group.
+        "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+        "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+        "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+        "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+        "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+        "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+        "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+        "notesCount": "A String", # Output only. The number of notes attached to an issue.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+        "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+          { # Distinctive characteristics assigned by the Crashlytics analyzer.
+            "description": "A String", # Output only. Supporting detail information.
+            "signal": "A String", # Output only. The signal name.
+          },
+        ],
+        "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+        "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+        "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+        "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+        "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+        "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+          { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+            "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+            "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+          },
+        ],
+      },
+      "metrics": [ # Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.
+        { # A set of computed metric values for a time interval
+          "endTime": "A String", # The end of the interval covered by the computation.
+          "eventsCount": "A String", # The total count of events in the interval.
+          "impactedUsersCount": "A String", # The number of distinct users in the set of events.
+          "sessionsCount": "A String", # The number of distinct sessions in the set of events.
+          "startTime": "A String", # The start of the interval covered by the computation.
+        },
+      ],
+      "operatingSystem": { # Mobile device operating system metadata. # Operating system metrics group.
+        "deviceType": "A String", # The device category (mobile, tablet, desktop).
+        "displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
+        "displayVersion": "A String", # Operating system display version number.
+        "modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
+        "os": "A String", # Operating system name.
+        "type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
+      },
+      "subgroups": [ # When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.
+        # Object with schema name: ReportGroup
+      ],
+      "variant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Issue variant metrics group.
+        "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+        "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+        "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+      },
+      "version": { # Application software version. # Version metrics group.
+        "buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
+        "displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
+        "displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
+        "tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
+          { # Describes a release track in the Play Developer Console.
+            "title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
+            "type": "A String", # The type of track (prod, internal, etc...).
+          },
+        ],
+      },
+      "webMetricsGroup": { # Represents a grouping for metrics specific to web applications. # Web metrics group.
+        "id": "A String", # The id of the web metrics group
+      },
+    },
+  ],
+  "name": "A String", # The name of the report. Format: "projects/{project}/apps/{app_id}/reports/{report}".
+  "nextPageToken": "A String", # Output only. A page token used to retrieve additional report groups. If this field is not present, there are no subsequent pages available to retrieve.
+  "totalSize": 42, # Output only. The total number of groups retrievable by the request.
+  "usage": "A String", # Usage instructions for the report with a description of the result metrics. This field contains a description of the underlying query and describes the expected response data with any known caveats. This string can be displayed in the UI of any integration that offers comprehensive access to all Crashlytics reports.
+}
+
+ +
+ get_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.
+        
+
+ +
+ list(parent, x__xgafv=None) +
List all of the available reports.
+
+Args:
+  parent: string, Required. The firebase application. Format: "projects/{project}/apps/{app_id}". (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response method for the ListReports method. The response will always include all of the available reports.
+  "reports": [ # The report objects returned will contain their names and usage instructions, but include no results. Use the `GetReport` method to run the report and obtain the paged results.
+    { # Response message for the GetReport method. A report consists of the results of a query over an application's events. The events may be filtered by various criteria defined in the filters proto. The result will consist of a number of paginated groups, of a type relevant to the report such as issues or device models.
+      "displayName": "A String", # Output only. The displayable title of the report.
+      "groups": [ # Aggregate event statistics in the report will be grouped by a dimension, such as by issue or by version. The response contains one element per group, and all ReportGroup messages will have the same parent field.
+        { # A group of results in an EventReport. In any report, the group_parent field is strictly the same type for all of the groups in any collection.
+          "browser": { # Web browser metadata. # Browser metrics group.
+            "browser": "A String", # Browser name.
+            "displayName": "A String", # Browser name and version number. Formatted to be suitable for passing to BrowserFilter.
+            "displayVersion": "A String", # Browser display version number.
+          },
+          "device": { # Mobile device metadata. # Device metrics group.
+            "architecture": "A String", # Device processor architecture.
+            "companyName": "A String", # An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. "Google".
+            "displayName": "A String", # Full device name, suitable for passing to DeviceFilter. Format: "manufacturer (model)".
+            "formFactor": "A String", # See FormFactor message.
+            "manufacturer": "A String", # Device brand name which is consistent with android.os.Build.BRAND.
+            "marketingName": "A String", # Marketing name, most recognizable public form, e.g. "Pixel 6".
+            "model": "A String", # The model name which is consistent with android.os.Build.MODEL, e.g. ("SPH-L710", "GT-I9300").
+          },
+          "issue": { # An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread. # Issue metrics group.
+            "errorType": "A String", # Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.
+            "firstSeenTime": "A String", # Output only. Immutable. The first time this issue was seen.
+            "firstSeenVersion": "A String", # Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.
+            "id": "A String", # Output only. Immutable. Unique identifier for the issue.
+            "lastSeenTime": "A String", # Output only. The most recent time this issue was seen.
+            "lastSeenVersion": "A String", # Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.
+            "name": "A String", # Required. Output only. Immutable. Identifier. The name of the issue resource. Format: "projects/{project}/apps/{app}/issues/{issue}".
+            "notesCount": "A String", # Output only. The number of notes attached to an issue.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this issue.
+            "signals": [ # Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.
+              { # Distinctive characteristics assigned by the Crashlytics analyzer.
+                "description": "A String", # Output only. Supporting detail information.
+                "signal": "A String", # Output only. The signal name.
+              },
+            ],
+            "state": "A String", # Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).
+            "stateUpdateTime": "A String", # Output only. The time at which the issue state was last changed.
+            "subtitle": "A String", # Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.
+            "title": "A String", # Output only. Immutable. Caption title. This is usually a source file or method name.
+            "uri": "A String", # Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+            "variants": [ # Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.
+              { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.
+                "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+                "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+                "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+              },
+            ],
+          },
+          "metrics": [ # Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.
+            { # A set of computed metric values for a time interval
+              "endTime": "A String", # The end of the interval covered by the computation.
+              "eventsCount": "A String", # The total count of events in the interval.
+              "impactedUsersCount": "A String", # The number of distinct users in the set of events.
+              "sessionsCount": "A String", # The number of distinct sessions in the set of events.
+              "startTime": "A String", # The start of the interval covered by the computation.
+            },
+          ],
+          "operatingSystem": { # Mobile device operating system metadata. # Operating system metrics group.
+            "deviceType": "A String", # The device category (mobile, tablet, desktop).
+            "displayName": "A String", # Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.
+            "displayVersion": "A String", # Operating system display version number.
+            "modificationState": "A String", # Indicates if the OS has been modified or "jailbroken".
+            "os": "A String", # Operating system name.
+            "type": "A String", # The OS type on Apple platforms (iOS, iPadOS, etc.).
+          },
+          "subgroups": [ # When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.
+            # Object with schema name: ReportGroup
+          ],
+          "variant": { # A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants. # Issue variant metrics group.
+            "id": "A String", # Output only. Immutable. Distinct identifier for the variant.
+            "sampleEvent": "A String", # Output only. The resource name for a sample event in this variant.
+            "uri": "A String", # Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.
+          },
+          "version": { # Application software version. # Version metrics group.
+            "buildVersion": "A String", # Mobile only. One display_version can have many build_version. On Android, strictly the same as "version code". On iOS, strictly the same as "build number" or CFBundleVersion.
+            "displayName": "A String", # Compound readable string containing both display and build versions. Format: "display_version (build_version)" e.g. "1.2.3 (456)". This string can be used for filtering with the VersionFilter.display_name field.
+            "displayVersion": "A String", # Readable version string, e.g. "1.2.3". On Android, strictly the same as "version name". On iOS, strictly the same as "version number" or CFBundleShortVersionString.
+            "tracks": [ # Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.
+              { # Describes a release track in the Play Developer Console.
+                "title": "A String", # User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. "prod" and "internal" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.
+                "type": "A String", # The type of track (prod, internal, etc...).
+              },
+            ],
+          },
+          "webMetricsGroup": { # Represents a grouping for metrics specific to web applications. # Web metrics group.
+            "id": "A String", # The id of the web metrics group
+          },
+        },
+      ],
+      "name": "A String", # The name of the report. Format: "projects/{project}/apps/{app_id}/reports/{report}".
+      "nextPageToken": "A String", # Output only. A page token used to retrieve additional report groups. If this field is not present, there are no subsequent pages available to retrieve.
+      "totalSize": 42, # Output only. The total number of groups retrievable by the request.
+      "usage": "A String", # Usage instructions for the report with a description of the result metrics. This field contains a description of the underlying query and describes the expected response data with any known caveats. This string can be displayed in the UI of any integration that offers comprehensive access to all Crashlytics reports.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.users.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.users.html new file mode 100644 index 0000000000..10201aae26 --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.users.html @@ -0,0 +1,108 @@ + + + +

Firebase Crashlytics API . projects . apps . users

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ deleteCrashReports(name, x__xgafv=None)

+

Enqueues a request to permanently remove crash reports associated with the specified user. All reports belonging to the specified user will be deleted typically within 24 hours of receiving the crash report.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ deleteCrashReports(name, x__xgafv=None) +
Enqueues a request to permanently remove crash reports associated with the specified user. All reports belonging to the specified user will be deleted typically within 24 hours of receiving the crash report.
+
+Args:
+  name: string, Required. Resource name for user reports, in the format: projects/ PROJECT_IDENTIFIER/apps/APP_ID/users/USER_ID/crashReports - PROJECT_IDENTIFIER: The Firebase project's project number (recommended) or its project ID. Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - APP_ID: The globally unique, Firebase-assigned identifier for the Firebase App. This is not your package name or bundle ID. Learn how to [find your app ID](https://firebase.google.com/support/faq/#find-app-id). - USER_ID: The user ID set using the Crashlytics SDK. Learn how to [set user identifiers](https://firebase.google.com/docs/crashlytics/customize-crash-reports#set-user-ids). (required)
+  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 the DeleteUserCrashReports method. All crash reports associated with the specified user will be deleted typically within 24 hours of receiving the crash report.
+  "targetCompleteTime": "A String", # Target time to complete the delete crash reports operation.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.html new file mode 100644 index 0000000000..424d2a0b5b --- /dev/null +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.html @@ -0,0 +1,91 @@ + + + +

Firebase Crashlytics API . projects

+

Instance Methods

+

+ apps() +

+

Returns the apps Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html index 39ceb9dee3..612721a2b1 100644 --- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html +++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html @@ -126,7 +126,7 @@

Method Details

Returns: An object of the form: - { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + { # Represents a service account key. A service account has two sets of key-pairs: user-managed and system-managed. System-managed keys are also called _Google-owned and managed keys_. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys that are actively used for signing are rotated regularly according to [security best practices](https://docs.cloud.google.com/iam/docs/key-rotation#timing). The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -234,7 +234,7 @@

Method Details

Returns: An object of the form: - { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + { # Represents a service account key. A service account has two sets of key-pairs: user-managed and system-managed. System-managed keys are also called _Google-owned and managed keys_. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys that are actively used for signing are rotated regularly according to [security best practices](https://docs.cloud.google.com/iam/docs/key-rotation#timing). The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -276,7 +276,7 @@

Method Details

{ # The service account keys list response. "keys": [ # The public keys for the service account. - { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + { # Represents a service account key. A service account has two sets of key-pairs: user-managed and system-managed. System-managed keys are also called _Google-owned and managed keys_. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys that are actively used for signing are rotated regularly according to [security best practices](https://docs.cloud.google.com/iam/docs/key-rotation#timing). The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -320,7 +320,7 @@

Method Details

Returns: An object of the form: - { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + { # Represents a service account key. A service account has two sets of key-pairs: user-managed and system-managed. System-managed keys are also called _Google-owned and managed keys_. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys that are actively used for signing are rotated regularly according to [security best practices](https://docs.cloud.google.com/iam/docs/key-rotation#timing). The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. diff --git a/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html b/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html index 61c291be6c..7f0f4dcdd3 100644 --- a/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html +++ b/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.

+

Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.

list_next()

Retrieves the next page of results.

@@ -91,10 +91,10 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.
+  
Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.
 
 Args:
-  parent: string, Required. The account to list aggregate product statuses for. Format: `accounts/{account}` (required)
+  parent: string, Required. The account to list aggregate product statuses for. Format: `accounts/{account}` Can only be sub-accounts and standalone accounts. (required)
   filter: string, Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`.
   pageSize: integer, Optional. The maximum number of aggregate product statuses to return. The service may return fewer than this value. If unspecified, at most 25 aggregate product statuses are returned. The maximum value is 250; values above 250 are coerced to 250.
   pageToken: string, Optional. A page token, received from a previous `ListAggregateProductStatuses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAggregateProductStatuses` must match the call that provided the page token.
diff --git a/docs/dyn/merchantapi_issueresolution_v1beta.accounts.aggregateProductStatuses.html b/docs/dyn/merchantapi_issueresolution_v1beta.accounts.aggregateProductStatuses.html
index ad5e143414..4c801821c6 100644
--- a/docs/dyn/merchantapi_issueresolution_v1beta.accounts.aggregateProductStatuses.html
+++ b/docs/dyn/merchantapi_issueresolution_v1beta.accounts.aggregateProductStatuses.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.

+

Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.

list_next()

Retrieves the next page of results.

@@ -91,10 +91,10 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.
+  
Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.
 
 Args:
-  parent: string, Required. The account to list aggregate product statuses for. Format: `accounts/{account}` (required)
+  parent: string, Required. The account to list aggregate product statuses for. Format: `accounts/{account}` Can only be sub-accounts and standalone accounts. (required)
   filter: string, Optional. A filter expression that filters the aggregate product statuses. Filtering is only supported by the `reporting_context` and `country` field. For example: `reporting_context = "SHOPPING_ADS" AND country = "US"`.
   pageSize: integer, Optional. The maximum number of aggregate product statuses to return. The service may return fewer than this value. If unspecified, at most 25 aggregate product statuses are returned. The maximum value is 250; values above 250 are coerced to 250.
   pageToken: string, Optional. A page token, received from a previous `ListAggregateProductStatuses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAggregateProductStatuses` must match the call that provided the page token.
diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
index b3f6b0c72d..6d84761194 100644
--- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
+++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html
@@ -569,7 +569,7 @@ 

Method Details

Lists the locations for the specified account.
 
 Args:
-  parent: string, Required. The name of the account to fetch locations from. If the parent Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly. (required)
+  parent: string, Required. The name of the account to fetch locations from. * **Specific Account ID**: If the account is of type `AccountType.PERSONAL`, the response returns only locations directly owned by that account. For all other types (e.g., `AccountType.LOCATION_GROUP`), it returns all accessible locations. * **Wildcard (`-`)**: Using `accounts/-` identifies the authenticated user. This scope defaults to `AccountType.PERSONAL` but includes both directly and indirectly owned locations (e.g., those accessible via member groups). (required)
   filter: string, Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If `filter` is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see [Work with Location Data Guide](https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations).
   orderBy: string, Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"
   pageSize: integer, Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.
diff --git a/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
index a92d7426da..d4d792fb1a 100644
--- a/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
+++ b/docs/dyn/networksecurity_v1.organizations.locations.securityProfileGroups.html
@@ -114,7 +114,7 @@ 

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -210,7 +210,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -246,7 +246,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -288,7 +288,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. diff --git a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html index 20b0f17671..3e377d06a6 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1.projects.locations.authzPolicies.html @@ -143,7 +143,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -181,7 +181,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -362,7 +362,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -400,7 +400,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -681,7 +681,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -719,7 +719,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -900,7 +900,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -938,7 +938,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1207,7 +1207,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1245,7 +1245,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1426,7 +1426,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1464,7 +1464,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1694,7 +1694,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1732,7 +1732,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1913,7 +1913,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1951,7 +1951,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` diff --git a/docs/dyn/networksecurity_v1.projects.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1.projects.locations.securityProfileGroups.html index edcbdb9f7d..62c1e4fc2c 100644 --- a/docs/dyn/networksecurity_v1.projects.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1.projects.locations.securityProfileGroups.html @@ -114,7 +114,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -210,7 +210,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -246,7 +246,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -288,7 +288,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. diff --git a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html index 2e411df97a..0da785ca48 100644 --- a/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1beta1.organizations.locations.securityProfileGroups.html @@ -114,7 +114,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -211,7 +211,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -248,7 +248,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -291,7 +291,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html index 605508ca71..99bc282b1b 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -143,7 +143,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -181,7 +181,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -362,7 +362,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -400,7 +400,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -681,7 +681,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -719,7 +719,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -900,7 +900,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -938,7 +938,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1207,7 +1207,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1245,7 +1245,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1426,7 +1426,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1464,7 +1464,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1694,7 +1694,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1732,7 +1732,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1913,7 +1913,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` @@ -1951,7 +1951,7 @@

Method Details

"prefix": "A String", # Required. The address prefix. }, ], - "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers. + "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers. { # Describes the properties of a principal to be matched against. "principal": { # Determines how a string value should be matched. # Required. A non-empty string whose value is matched against the principal value based on the principal_selector. Only exact match can be applied for CLIENT_CERT_URI_SAN, CLIENT_CERT_DNS_NAME_SAN, CLIENT_CERT_COMMON_NAME selectors. "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html index 81bf637500..2b2e94c692 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.securityProfileGroups.html @@ -114,7 +114,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -211,7 +211,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -248,7 +248,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. @@ -291,7 +291,7 @@

Method Details

"createTime": "A String", # Output only. Resource creation timestamp. "customInterceptProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomIntercept configuration. "customMirroringProfile": "A String", # Optional. Reference to a SecurityProfile with the CustomMirroring configuration. - "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within {container, location}. + "dataPathId": "A String", # Output only. Identifier used by the data-path. Unique within `{container, location}`. "description": "A String", # Optional. An optional description of the profile group. Max length 2048 characters. "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. "labels": { # Optional. Labels as key value pairs. diff --git a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html index 6e9a110013..983db00eda 100644 --- a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html +++ b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.openid.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

getJwks(name, x__xgafv=None)

-

Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.

+

Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).

Method Details

close() @@ -88,7 +88,7 @@

Method Details

getJwks(name, x__xgafv=None) -
Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.
+  
Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
 
 Args:
   name: string, Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' 'projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog' (required)
diff --git a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.well_known.html b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.well_known.html
index 8d61a36838..4d479a9c37 100644
--- a/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.well_known.html
+++ b/docs/dyn/sts_v1.organizations.locations.workloadIdentityPools.well_known.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

getOpenid_configuration(name, x__xgafv=None)

-

Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.

+

Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).

Method Details

close() @@ -88,7 +88,7 @@

Method Details

getOpenid_configuration(name, x__xgafv=None) -
Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.
+  
Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
 
 Args:
   name: string, Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' 'projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog' (required)
diff --git a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html
index 35252af5ea..b78c740367 100644
--- a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html
+++ b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.openid.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

getJwks(name, x__xgafv=None)

-

Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.

+

Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).

Method Details

close() @@ -88,7 +88,7 @@

Method Details

getJwks(name, x__xgafv=None) -
Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.
+  
Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
 
 Args:
   name: string, Required. The name of the pool whose JWKS needs to be retrieved. Format: 'organizations/{ORGANIZATION_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' 'projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' Example(s): 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog' (required)
diff --git a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.well_known.html b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.well_known.html
index 167a0f51e8..04d0b95c0e 100644
--- a/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.well_known.html
+++ b/docs/dyn/sts_v1.projects.locations.workloadIdentityPools.well_known.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

getOpenid_configuration(name, x__xgafv=None)

-

Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.

+

Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).

Method Details

close() @@ -88,7 +88,7 @@

Method Details

getOpenid_configuration(name, x__xgafv=None) -
Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.
+  
Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available "as is" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).
 
 Args:
   name: string, Required. The name of the pool whose OpenID provider configuration to retrieve. Format: 'organizations/{ORGANIZATION_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' 'projects/{PROJECT_NUMBER}/locations/global/workloadIdentityPools/{POOL_ID}' Example: 'organizations/1234/locations/global/workloadIdentityPools/agents.global.org-1234.system.id.goog' 'projects/12345678/locations/global/workloadIdentityPools/agents.global.proj-12345678.system.id.goog' (required)
diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json
index f83a50d088..ef274ff437 100644
--- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json
+++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json
@@ -913,7 +913,7 @@
 }
 }
 },
-"revision": "20260126",
+"revision": "20260703",
 "rootUrl": "https://accessapproval.googleapis.com/",
 "schemas": {
 "AccessApprovalServiceAccount": {
@@ -1351,7 +1351,8 @@
 "PQ_SIGN_HASH_SLH_DSA_SHA2_128S_SHA256",
 "PQ_SIGN_ML_DSA_44_EXTERNAL_MU",
 "PQ_SIGN_ML_DSA_65_EXTERNAL_MU",
-"PQ_SIGN_ML_DSA_87_EXTERNAL_MU"
+"PQ_SIGN_ML_DSA_87_EXTERNAL_MU",
+"AES_256_KWP"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -1400,7 +1401,8 @@
 "The post-quantum stateless hash-based digital signature algorithm, at security level 1. Randomized pre-hash version supporting SHA256 digests.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 1. Randomized version supporting externally-computed message representatives.",
 "The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 3. Randomized version supporting externally-computed message representatives.",
-"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives."
+"The post-quantum Module-Lattice-Based Digital Signature Algorithm, at security level 5. Randomized version supporting externally-computed message representatives.",
+"AES key wrap with zero padding algorithm (RFC 5649). Can only be used by keys with purpose AES_WRAPPING."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
index d40aa42445..cdb2093706 100644
--- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json
@@ -423,7 +423,7 @@
 }
 }
 },
-"revision": "20260525",
+"revision": "20260706",
 "rootUrl": "https://alertcenter.googleapis.com/",
 "schemas": {
 "AbuseDetected": {
@@ -1856,11 +1856,13 @@
 "description": "Optional. Agent type that triggered the rule.",
 "enum": [
 "AGENT_TYPE_UNSPECIFIED",
-"STUDIO"
+"STUDIO",
+"WORK_AGENT"
 ],
 "enumDescriptions": [
 "Unspecified agent type.",
-"Studio agent type."
+"Studio agent type.",
+"Work Agent agent type."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
index 8dc710cb9d..445e0ca47b 100644
--- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
+++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json
@@ -309,7 +309,7 @@
 ],
 "parameters": {
 "pageSize": {
-"description": "Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.",
+"description": "Optional. The maximum number of devices to show in a page of results. If unset or 0, defaults to 1000. If a value greater than 1000 is specified, it will be coerced to 1000.",
 "format": "int64",
 "location": "query",
 "type": "string"
@@ -851,7 +851,7 @@
 }
 }
 },
-"revision": "20250331",
+"revision": "20260712",
 "rootUrl": "https://androiddeviceprovisioning.googleapis.com/",
 "schemas": {
 "ClaimDeviceRequest": {
diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
index a26e59c3f4..4098d73c72 100644
--- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
+++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json
@@ -2691,7 +2691,7 @@
 }
 }
 },
-"revision": "20260422",
+"revision": "20260707",
 "rootUrl": "https://androidenterprise.googleapis.com/",
 "schemas": {
 "Administrator": {
@@ -3324,7 +3324,7 @@
 "id": "EnrollmentToken",
 "properties": {
 "duration": {
-"description": "[Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour.",
+"description": "[Optional] The length of time the enrollment token is valid, ranging from 1 minute to [`Durations.MAX_VALUE`](https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/util/Durations.html#MAX_VALUE), approximately 10,000 years. If not specified, the default duration is 1 hour. In the JSON REST API, this is represented as a string (e.g., `3600s`).",
 "format": "google-duration",
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
index 67fa480402..d018719bbc 100644
--- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json
@@ -1265,7 +1265,7 @@
 }
 }
 },
-"revision": "20260615",
+"revision": "20260708",
 "rootUrl": "https://androidmanagement.googleapis.com/",
 "schemas": {
 "AdbShellCommandEvent": {
@@ -6261,7 +6261,7 @@ false
 "type": "boolean"
 },
 "defaultApplicationSettings": {
-"description": "Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.",
+"description": "Optional. The default application setting for supported types. If the default application is successfully set for at least one app type on a profile, users are prevented from changing any default applications on that profile.Only one DefaultApplicationSetting is allowed for each DefaultApplicationType.Warning: Do not configure this and persistent_preferred_activities for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.See Default application settings (https://developers.google.com/android/management/default-application-settings) guide for more details.",
 "items": {
 "$ref": "DefaultApplicationSetting"
 },
@@ -6542,7 +6542,7 @@ false
 "description": "If present, only the input methods provided by packages in this list are permitted. If this field is present, but the list is empty, then only system input methods are permitted."
 },
 "persistentPreferredActivities": {
-"description": "Default intent handler activities.",
+"description": "Default intent handler activities.Warning: Do not configure this and default_application_settings for the same intent domain, such as web browsing. Setting both for the same intent domain can lead to unpredictable behavior.",
 "items": {
 "$ref": "PersistentPreferredActivity"
 },
@@ -7794,8 +7794,8 @@ false
 ],
 "enumDescriptions": [
 "This value is not used.",
-"Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS",
-"Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS"
+"Enable logging of on-device security events, such as when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS",
+"Enable logging of on-device network events, such as DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS"
 ],
 "type": "string"
 },
@@ -7811,8 +7811,8 @@ false
 ],
 "enumDescriptions": [
 "This value is not used.",
-"Enable logging of on-device security events, like when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS",
-"Enable logging of on-device network events, like DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS"
+"Enable logging of on-device security events, such as when the device password is incorrectly entered or removable storage is mounted. See UsageLogEvent for a complete description of the logged security events. Supported for fully managed devices on Android 7 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only security events from the work profile are logged. Can be overridden by the application delegated scope SECURITY_LOGS",
+"Enable logging of on-device network events, such as DNS lookups and TCP connections. See UsageLogEvent for a complete description of the logged network events. Supported for fully managed devices on Android 8 and above. Supported for company-owned devices with a work profile on Android 12 and above, on which only network events from the work profile are logged. Can be overridden by the application delegated scope NETWORK_ACTIVITY_LOGS"
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
index 5f4efe16b1..cf79b42204 100644
--- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
+++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json
@@ -2362,7 +2362,7 @@
 "type": "string"
 },
 "updateMask": {
-"description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.",
+"description": "Required. The list of fields to update. A mask specifying which fields (e.g. `change_stream_config`) in the `table` field should be updated. This mask is relative to the `table` field, not to the request message. The wildcard (*) path is currently not supported. Currently UpdateTable is only supported for the following fields: * `change_stream_config` * `change_stream_config.retention_period` * `deletion_protection` * `automated_backup_policy` * `automated_backup_policy.retention_period` * `automated_backup_policy.frequency` * `automated_backup_policy.locations` * `row_key_schema` If `column_families` is set in `update_mask`, it will return an UNIMPLEMENTED error.",
 "format": "google-fieldmask",
 "location": "query",
 "type": "string"
@@ -3194,7 +3194,7 @@
 }
 }
 },
-"revision": "20260624",
+"revision": "20260708",
 "rootUrl": "https://bigtableadmin.googleapis.com/",
 "schemas": {
 "AppProfile": {
diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
index b971d679fe..9c5d1da215 100644
--- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
+++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1.json
@@ -747,7 +747,7 @@
 }
 }
 },
-"revision": "20250311",
+"revision": "20260703",
 "rootUrl": "https://binaryauthorization.googleapis.com/",
 "schemas": {
 "AdmissionRule": {
@@ -1375,7 +1375,8 @@
 "ECDSA_P384_SHA384",
 "EC_SIGN_P384_SHA384",
 "ECDSA_P521_SHA512",
-"EC_SIGN_P521_SHA512"
+"EC_SIGN_P521_SHA512",
+"ML_DSA_65"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -1396,7 +1397,8 @@
 "ECDSA on the NIST P-384 curve with a SHA384 digest.",
 "ECDSA on the NIST P-384 curve with a SHA384 digest.",
 "ECDSA on the NIST P-521 curve with a SHA512 digest.",
-"ECDSA on the NIST P-521 curve with a SHA512 digest."
+"ECDSA on the NIST P-521 curve with a SHA512 digest.",
+"ML-DSA-65 Post-Quantum Cryptography signature algorithm."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
index 6b84d35acb..429f1d080f 100644
--- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json
@@ -551,7 +551,7 @@
 }
 }
 },
-"revision": "20241018",
+"revision": "20260703",
 "rootUrl": "https://binaryauthorization.googleapis.com/",
 "schemas": {
 "AdmissionRule": {
@@ -818,7 +818,8 @@
 "ECDSA_P384_SHA384",
 "EC_SIGN_P384_SHA384",
 "ECDSA_P521_SHA512",
-"EC_SIGN_P521_SHA512"
+"EC_SIGN_P521_SHA512",
+"ML_DSA_65"
 ],
 "enumDescriptions": [
 "Not specified.",
@@ -839,7 +840,8 @@
 "ECDSA on the NIST P-384 curve with a SHA384 digest.",
 "ECDSA on the NIST P-384 curve with a SHA384 digest.",
 "ECDSA on the NIST P-521 curve with a SHA512 digest.",
-"ECDSA on the NIST P-521 curve with a SHA512 digest."
+"ECDSA on the NIST P-521 curve with a SHA512 digest.",
+"ML-DSA-65 Post-Quantum Cryptography signature algorithm."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json
index e9a7283016..78ae192d98 100644
--- a/googleapiclient/discovery_cache/documents/blogger.v3.json
+++ b/googleapiclient/discovery_cache/documents/blogger.v3.json
@@ -1713,7 +1713,7 @@
 }
 }
 },
-"revision": "20260521",
+"revision": "20260707",
 "rootUrl": "https://blogger.googleapis.com/",
 "schemas": {
 "Blog": {
@@ -2554,6 +2554,6 @@
 }
 },
 "servicePath": "",
-"title": "blogger API",
+"title": "Blogger API",
 "version": "v3"
 }
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
index 309b1d6ff9..71ceef40b5 100644
--- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
+++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json
@@ -522,7 +522,7 @@
 ],
 "parameters": {
 "connectorConfigId": {
-"description": "Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-63 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID.",
+"description": "Optional. ID to use for the connector config, which becomes the final component of the connector config's resource name. If provided, the ID must be 1-36 characters long, and contain only lowercase letters, digits, and hyphens. It must start with a letter, and end with a letter or number. If not provided, the connector config will be assigned a random UUID.",
 "location": "query",
 "type": "string"
 },
@@ -2409,7 +2409,7 @@
 }
 }
 },
-"revision": "20260611",
+"revision": "20260709",
 "rootUrl": "https://chromemanagement.googleapis.com/",
 "schemas": {
 "GoogleChromeManagementV1AndroidAppInfo": {
@@ -4968,10 +4968,17 @@ false
 "RISK_ASSESSMENT_PROVIDER_LAYERX",
 "RISK_ASSESSMENT_PROVIDER_SPIN_AI_V2"
 ],
+"enumDeprecated": [
+false,
+false,
+true,
+false,
+false
+],
 "enumDescriptions": [
 "Default value when no provider is specified.",
 "CRXcavator.",
-"Spin.Ai.",
+"Deprecated: Please use RISK_ASSESSMENT_PROVIDER_SPIN_AI_V2 instead. Spin.Ai.",
 "LayerX Security.",
 "Spin.AI V2."
 ],
diff --git a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
index 6846aa3809..f02ec52734 100644
--- a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json
@@ -1456,7 +1456,7 @@
 }
 }
 },
-"revision": "20260527",
+"revision": "20260708",
 "rootUrl": "https://cloudnumberregistry.googleapis.com/",
 "schemas": {
 "AggregatedData": {
@@ -2262,7 +2262,7 @@ true
 "type": "object"
 },
 "managementType": {
-"description": "Required. Management type of the Realm.",
+"description": "Optional. Management type of the Realm.",
 "enum": [
 "MANAGEMENT_TYPE_UNSPECIFIED",
 "CNR",
diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json
index 982be17e24..d31dac6f8e 100644
--- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json
+++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json
@@ -1715,7 +1715,7 @@
 }
 }
 },
-"revision": "20260619",
+"revision": "20260703",
 "rootUrl": "https://containeranalysis.googleapis.com/",
 "schemas": {
 "AISkillAnalysisNote": {
@@ -5180,13 +5180,15 @@ false
 "SCANNER_UNSPECIFIED",
 "STATIC",
 "LLM",
-"WS_POLICY"
+"WS_POLICY",
+"GOOGLE_ANTIVIRUS"
 ],
 "enumDescriptions": [
 "Unspecified scanner.",
 "Static scanner.",
 "LLM scanner.",
-"WS_POLICY scanner."
+"WS_POLICY scanner.",
+"Google AntiVirus Service scanner."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
index 8dbaaaf13d..381e88a8df 100644
--- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json
@@ -1454,7 +1454,7 @@
 }
 }
 },
-"revision": "20260619",
+"revision": "20260703",
 "rootUrl": "https://containeranalysis.googleapis.com/",
 "schemas": {
 "AISkillAnalysisNote": {
@@ -4974,13 +4974,15 @@ false
 "SCANNER_UNSPECIFIED",
 "STATIC",
 "LLM",
-"WS_POLICY"
+"WS_POLICY",
+"GOOGLE_ANTIVIRUS"
 ],
 "enumDescriptions": [
 "Unspecified scanner.",
 "Static scanner.",
 "LLM scanner.",
-"WS_POLICY scanner."
+"WS_POLICY scanner.",
+"Google AntiVirus Service scanner."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
index bd95235ef5..30b96489f1 100644
--- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json
@@ -1771,7 +1771,7 @@
 }
 }
 },
-"revision": "20260619",
+"revision": "20260703",
 "rootUrl": "https://containeranalysis.googleapis.com/",
 "schemas": {
 "AISkillAnalysisNote": {
@@ -5291,13 +5291,15 @@ false
 "SCANNER_UNSPECIFIED",
 "STATIC",
 "LLM",
-"WS_POLICY"
+"WS_POLICY",
+"GOOGLE_ANTIVIRUS"
 ],
 "enumDescriptions": [
 "Unspecified scanner.",
 "Static scanner.",
 "LLM scanner.",
-"WS_POLICY scanner."
+"WS_POLICY scanner.",
+"Google AntiVirus Service scanner."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json
index b2df991468..07e69fe0e9 100644
--- a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json
@@ -364,7 +364,7 @@
 }
 }
 },
-"revision": "20260619",
+"revision": "20260702",
 "rootUrl": "https://databasecenter.googleapis.com/",
 "schemas": {
 "AdditionalDetail": {
@@ -538,7 +538,8 @@
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -642,7 +643,8 @@
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
@@ -1612,7 +1614,8 @@ false
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -1716,7 +1719,8 @@ false
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
@@ -2718,7 +2722,8 @@ false
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -2822,7 +2827,8 @@ false
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
@@ -2955,7 +2961,8 @@ false
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -3059,7 +3066,8 @@ false
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
@@ -3204,7 +3212,8 @@ false
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -3308,7 +3317,8 @@ false
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
@@ -3428,7 +3438,8 @@ false
 "SIGNAL_TYPE_EXTENDED_SUPPORT",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDescriptions": [
 "Unspecified.",
@@ -3532,7 +3543,8 @@ false
 "Resource version is in extended support.",
 "Represents a database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/datamanager.v1.json b/googleapiclient/discovery_cache/documents/datamanager.v1.json
index e2fb75c46e..6a023ef5e5 100644
--- a/googleapiclient/discovery_cache/documents/datamanager.v1.json
+++ b/googleapiclient/discovery_cache/documents/datamanager.v1.json
@@ -211,12 +211,12 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`",
+"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` - `feature_set` For partner links with the FEATURE_SET_AD_EVENT_MANAGEMENT feature set, the following fields are also supported: - `partner_customer_account.account_id` Example: `owning_account.account_type = \"GOOGLE_ADS\" AND partner_account.account_id = 987654321`",
 "location": "query",
 "type": "string"
 },
 "pageSize": {
-"description": "The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
+"description": "The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 50 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.",
 "format": "int32",
 "location": "query",
 "type": "integer"
@@ -310,7 +310,7 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
+"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
 "location": "query",
 "type": "string"
 },
@@ -442,7 +442,7 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
+"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
 "location": "query",
 "type": "string"
 },
@@ -521,7 +521,7 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
+"description": "Optional. A [filter string](https://google.aip.dev/160) to apply to the list request. All fields need to be on the left hand side of each condition (for example: `user_list_id = 123`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. **Supported Operations:** - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(user_list_id, 123, 456)` **Unsupported Fields:** - `name` (use get method instead) - `historical_pricings` and all its subfields - `pricing.start_time` - `pricing.end_time`",
 "location": "query",
 "type": "string"
 },
@@ -656,7 +656,7 @@
 ],
 "parameters": {
 "filter": {
-"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = \"list 1\"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`",
+"description": "Optional. A [filter string](https://google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `display_name = \"list 1\"`). Fields must be specified using either all [camel case](https://en.wikipedia.org/wiki/Camel_case) or all [snake case](https://en.wikipedia.org/wiki/Snake_case). Don't use a combination of camel case and snake case. Supported operations: - `AND` - `=` - `!=` - `>` - `>=` - `<` - `<=` - `:` (has) **Supported Functions:** - `IN(field, value1, value2, ...)`: returns true if the field matches any of the values. Example: `IN(display_name, \"name1\", \"name2\")` Supported fields: - `id` - `display_name` - `description` - `membership_status` - `integration_code` - `access_reason` - `ingested_user_list_info.upload_key_types`",
 "location": "query",
 "type": "string"
 },
@@ -842,7 +842,7 @@
 }
 }
 },
-"revision": "20260605",
+"revision": "20260708",
 "rootUrl": "https://datamanager.googleapis.com/",
 "schemas": {
 "AdEvent": {
@@ -1714,7 +1714,8 @@
 "PROCESSING_ERROR_REASON_TOO_RECENT_CLICK",
 "PROCESSING_ERROR_REASON_INVALID_CLICK",
 "PROCESSING_ERROR_REASON_INVALID_OPERATING_ACCOUNT_FOR_CLICK",
-"PROCESSING_ERROR_REASON_CLICK_NOT_FOUND"
+"PROCESSING_ERROR_REASON_CLICK_NOT_FOUND",
+"PROCESSING_ERROR_REASON_EXTERNAL_ATTRIBUTION_DATA_MISSING"
 ],
 "enumDescriptions": [
 "The processing error reason is unknown.",
@@ -1760,7 +1761,8 @@
 "The click occurred too recently.",
 "The event can't be attributed to a click (GCLID). This may be because the click did not come from a Google Ads campaign, for example.",
 "The click from the event isn't associated with the `operating_account` of the destination.",
-"A corresponding click can't be found that matches the provided attributes."
+"A corresponding click can't be found that matches the provided attributes.",
+"External attribution data is missing. Sending events to a destination for an external attribution conversion action isn't supported."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json
index 9f82140a91..3604dad5d6 100644
--- a/googleapiclient/discovery_cache/documents/documentai.v1.json
+++ b/googleapiclient/discovery_cache/documents/documentai.v1.json
@@ -1436,7 +1436,7 @@
 }
 }
 },
-"revision": "20260503",
+"revision": "20260706",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
@@ -1725,7 +1725,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the auto-labeled document. This will replace the gcs_uri."
+"description": "The document ID of the auto-labeled document. This will replace the gcs_uri."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -1773,7 +1773,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -1844,7 +1844,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -1882,7 +1882,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -2026,7 +2026,7 @@
 "properties": {
 "gcsManagedDocId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
-"description": "A document id within user-managed Cloud Storage."
+"description": "A document ID within user-managed Cloud Storage."
 },
 "revisionRef": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
@@ -2034,7 +2034,7 @@
 },
 "unmanagedDocId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
-"description": "A document id within unmanaged dataset."
+"description": "A document ID within unmanaged dataset."
 }
 },
 "type": "object"
@@ -2045,7 +2045,7 @@
 "properties": {
 "cwDocId": {
 "deprecated": true,
-"description": "Id of the document (indexed) managed by Content Warehouse.",
+"description": "ID of the document (indexed) managed by Content Warehouse.",
 "type": "string"
 },
 "gcsUri": {
@@ -2060,7 +2060,7 @@
 "id": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
 "properties": {
 "docId": {
-"description": "Required. The id of the document.",
+"description": "Required. The ID of the document.",
 "type": "string"
 }
 },
@@ -2079,7 +2079,7 @@
 "type": "string"
 },
 "documentPrompt": {
-"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
+"description": "Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
 "type": "string"
 },
 "entityTypes": {
@@ -2124,7 +2124,7 @@
 "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
 },
 "name": {
-"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
+"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
 "type": "string"
 },
 "properties": {
@@ -2610,7 +2610,7 @@
 },
 "outputDocumentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of imported document if it was successful, otherwise empty."
+"description": "The document ID of imported document if it was successful, otherwise empty."
 },
 "outputGcsDestination": {
 "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.",
@@ -2656,7 +2656,7 @@
 "id": "GoogleCloudDocumentaiUiv1beta3Processor",
 "properties": {
 "activeSchemaVersion": {
-"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.",
 "type": "string"
 },
 "createTime": {
@@ -3728,7 +3728,7 @@
 "id": "GoogleCloudDocumentaiV1Document",
 "properties": {
 "blobAssets": {
-"description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.",
+"description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID.",
 "items": {
 "$ref": "GoogleCloudDocumentaiV1DocumentBlobAsset"
 },
@@ -3759,7 +3759,7 @@
 "type": "array"
 },
 "entitiesRevisionId": {
-"description": "The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.",
+"description": "The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.",
 "type": "string"
 },
 "entitiesRevisions": {
@@ -3848,7 +3848,7 @@
 "id": "GoogleCloudDocumentaiV1DocumentBlobAsset",
 "properties": {
 "assetId": {
-"description": "Optional. The id of the blob asset.",
+"description": "Optional. The ID of the blob asset.",
 "type": "string"
 },
 "content": {
@@ -3995,15 +3995,15 @@
 "description": "Annotation of the image chunk field."
 },
 "blobAssetId": {
-"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
+"description": "Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field.",
 "type": "string"
 },
 "dataUri": {
-"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
+"description": "Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
 "type": "string"
 },
 "gcsUri": {
-"description": "Optional. Google Cloud Storage uri of the image.",
+"description": "Optional. Google Cloud Storage URI of the image.",
 "type": "string"
 }
 },
@@ -4078,15 +4078,15 @@
 "description": "Annotation of the image block."
 },
 "blobAssetId": {
-"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
+"description": "Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field.",
 "type": "string"
 },
 "dataUri": {
-"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
+"description": "Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
 "type": "string"
 },
 "gcsUri": {
-"description": "Optional. Google Cloud Storage uri of the image.",
+"description": "Optional. Google Cloud Storage URI of the image.",
 "type": "string"
 },
 "imageText": {
@@ -4372,7 +4372,7 @@
 "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
 },
 "signatureValue": {
-"description": "A signature - a graphical representation of a person's name, often used to sign a document.",
+"description": "A signature, which is a graphical representation of a person's name, often used to sign a document.",
 "type": "boolean"
 },
 "text": {
@@ -5224,7 +5224,7 @@
 "properties": {
 "id": {
 "deprecated": true,
-"description": "The Id of this operation. Needs to be unique within the scope of the revision.",
+"description": "The ID of this operation. Needs to be unique within the scope of the revision.",
 "format": "int32",
 "type": "integer"
 },
@@ -5284,7 +5284,7 @@ true
 "properties": {
 "id": {
 "deprecated": true,
-"description": "The id of the parent provenance.",
+"description": "The ID of the parent provenance.",
 "format": "int32",
 "type": "integer"
 },
@@ -5306,7 +5306,7 @@ true
 "id": "GoogleCloudDocumentaiV1DocumentRevision",
 "properties": {
 "agent": {
-"description": "If the change was made by a person specify the name or id of that person.",
+"description": "If the change was made by a person specify the name or ID of that person.",
 "type": "string"
 },
 "createTime": {
@@ -5319,7 +5319,7 @@ true
 "description": "Human Review information of this revision."
 },
 "id": {
-"description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
+"description": "ID of the revision, internally generated by doc proto storage. Unique within the context of the document.",
 "type": "string"
 },
 "parent": {
@@ -5373,7 +5373,7 @@ true
 "type": "string"
 },
 "documentPrompt": {
-"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
+"description": "Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
 "type": "string"
 },
 "entityTypes": {
@@ -5410,7 +5410,7 @@ true
 "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
 },
 "name": {
-"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
+"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
 "type": "string"
 },
 "properties": {
@@ -6514,7 +6514,7 @@ true
 "id": "GoogleCloudDocumentaiV1Processor",
 "properties": {
 "activeSchemaVersion": {
-"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.",
 "type": "string"
 },
 "createTime": {
@@ -7176,7 +7176,7 @@ true
 "type": "number"
 },
 "previousFineTunedProcessorVersionName": {
-"description": "Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
+"description": "Optional. Resource name of a previously fine tuned version ID to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
 "type": "string"
 },
 "trainSteps": {
@@ -7286,7 +7286,7 @@ true
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -7576,7 +7576,7 @@ true
 "properties": {
 "gcsManagedDocId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
-"description": "A document id within user-managed Cloud Storage."
+"description": "A document ID within user-managed Cloud Storage."
 },
 "revisionRef": {
 "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef",
@@ -7584,7 +7584,7 @@ true
 },
 "unmanagedDocId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
-"description": "A document id within unmanaged dataset."
+"description": "A document ID within unmanaged dataset."
 }
 },
 "type": "object"
@@ -7595,7 +7595,7 @@ true
 "properties": {
 "cwDocId": {
 "deprecated": true,
-"description": "Id of the document (indexed) managed by Content Warehouse.",
+"description": "ID of the document (indexed) managed by Content Warehouse.",
 "type": "string"
 },
 "gcsUri": {
@@ -7610,7 +7610,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
 "properties": {
 "docId": {
-"description": "Required. The id of the document.",
+"description": "Required. The ID of the document.",
 "type": "string"
 }
 },
@@ -7629,7 +7629,7 @@ true
 "type": "string"
 },
 "documentPrompt": {
-"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
+"description": "Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
 "type": "string"
 },
 "entityTypes": {
@@ -7674,7 +7674,7 @@ true
 "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
 },
 "name": {
-"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
+"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
 "type": "string"
 },
 "properties": {
@@ -8030,7 +8030,7 @@ true
 },
 "outputDocumentId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
-"description": "The document id of imported document if it was successful, otherwise empty."
+"description": "The document ID of imported document if it was successful, otherwise empty."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -8072,7 +8072,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3Processor",
 "properties": {
 "activeSchemaVersion": {
-"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.",
 "type": "string"
 },
 "createTime": {
diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
index 2073eea128..ccbd02b479 100644
--- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
+++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json
@@ -785,7 +785,7 @@
 },
 "documentId.gcsManagedDocId.cwDocId": {
 "deprecated": true,
-"description": "Id of the document (indexed) managed by Content Warehouse.",
+"description": "ID of the document (indexed) managed by Content Warehouse.",
 "location": "query",
 "type": "string"
 },
@@ -822,7 +822,7 @@
 "type": "string"
 },
 "documentId.unmanagedDocId.docId": {
-"description": "Required. The id of the document.",
+"description": "Required. The ID of the document.",
 "location": "query",
 "type": "string"
 },
@@ -1678,7 +1678,7 @@
 }
 }
 },
-"revision": "20260503",
+"revision": "20260706",
 "rootUrl": "https://documentai.googleapis.com/",
 "schemas": {
 "CloudAiDocumentaiLabHifiaToolsValidationValidatorInput": {
@@ -1967,7 +1967,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the auto-labeled document. This will replace the gcs_uri."
+"description": "The document ID of the auto-labeled document. This will replace the gcs_uri."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -2015,7 +2015,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -2086,7 +2086,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -2124,7 +2124,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -2268,7 +2268,7 @@
 "properties": {
 "gcsManagedDocId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdGCSManagedDocumentId",
-"description": "A document id within user-managed Cloud Storage."
+"description": "A document ID within user-managed Cloud Storage."
 },
 "revisionRef": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3RevisionRef",
@@ -2276,7 +2276,7 @@
 },
 "unmanagedDocId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
-"description": "A document id within unmanaged dataset."
+"description": "A document ID within unmanaged dataset."
 }
 },
 "type": "object"
@@ -2287,7 +2287,7 @@
 "properties": {
 "cwDocId": {
 "deprecated": true,
-"description": "Id of the document (indexed) managed by Content Warehouse.",
+"description": "ID of the document (indexed) managed by Content Warehouse.",
 "type": "string"
 },
 "gcsUri": {
@@ -2302,7 +2302,7 @@
 "id": "GoogleCloudDocumentaiUiv1beta3DocumentIdUnmanagedDocumentId",
 "properties": {
 "docId": {
-"description": "Required. The id of the document.",
+"description": "Required. The ID of the document.",
 "type": "string"
 }
 },
@@ -2321,7 +2321,7 @@
 "type": "string"
 },
 "documentPrompt": {
-"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
+"description": "Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
 "type": "string"
 },
 "entityTypes": {
@@ -2366,7 +2366,7 @@
 "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
 },
 "name": {
-"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
+"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
 "type": "string"
 },
 "properties": {
@@ -2852,7 +2852,7 @@
 },
 "outputDocumentId": {
 "$ref": "GoogleCloudDocumentaiUiv1beta3DocumentId",
-"description": "The document id of imported document if it was successful, otherwise empty."
+"description": "The document ID of imported document if it was successful, otherwise empty."
 },
 "outputGcsDestination": {
 "description": "The output_gcs_destination of the processed document if it was successful, otherwise empty.",
@@ -2898,7 +2898,7 @@
 "id": "GoogleCloudDocumentaiUiv1beta3Processor",
 "properties": {
 "activeSchemaVersion": {
-"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.",
 "type": "string"
 },
 "createTime": {
@@ -4159,7 +4159,7 @@
 "properties": {
 "documentId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
-"description": "The document id of the document."
+"description": "The document ID of the document."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -4603,7 +4603,7 @@
 "id": "GoogleCloudDocumentaiV1beta3Document",
 "properties": {
 "blobAssets": {
-"description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset id.",
+"description": "Optional. The blob assets in this document. This is used to store the content of the inline blobs in this document, for example, image bytes, such that it can be referenced by other fields in the document via asset ID.",
 "items": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentBlobAsset"
 },
@@ -4634,7 +4634,7 @@
 "type": "array"
 },
 "entitiesRevisionId": {
-"description": "The entity revision ID that `document.entities` field is based on. If this field is set and `entities_revisions` is not empty, the entities in `document.entities` field are the entities in the entity revision with this id and `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.",
+"description": "The entity revision ID that `document.entities` field is based on. If this field and `entities_revisions` are set, the entities in `document.entities` are the entities in the entity revision with this ID. The `document.entity_validation_output` field is the `entity_validation_output` field in this entity revision.",
 "type": "string"
 },
 "entitiesRevisions": {
@@ -4723,7 +4723,7 @@
 "id": "GoogleCloudDocumentaiV1beta3DocumentBlobAsset",
 "properties": {
 "assetId": {
-"description": "Optional. The id of the blob asset.",
+"description": "Optional. The ID of the blob asset.",
 "type": "string"
 },
 "content": {
@@ -4870,15 +4870,15 @@
 "description": "Annotation of the image chunk field."
 },
 "blobAssetId": {
-"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
+"description": "Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field.",
 "type": "string"
 },
 "dataUri": {
-"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
+"description": "Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
 "type": "string"
 },
 "gcsUri": {
-"description": "Optional. Google Cloud Storage uri of the image.",
+"description": "Optional. Google Cloud Storage URI of the image.",
 "type": "string"
 }
 },
@@ -4953,15 +4953,15 @@
 "description": "Annotation of the image block."
 },
 "blobAssetId": {
-"description": "Optional. Asset id of the inline image. If set, find the image content in the blob_assets field.",
+"description": "Optional. Asset ID of the inline image. If set, find the image content in the blob_assets field.",
 "type": "string"
 },
 "dataUri": {
-"description": "Optional. Data uri of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
+"description": "Optional. Data URI of the image. It is composed of four parts: a prefix (data:), a MIME type indicating the type of data, an optional base64 token if non-textual, and the data itself: data:,",
 "type": "string"
 },
 "gcsUri": {
-"description": "Optional. Google Cloud Storage uri of the image.",
+"description": "Optional. Google Cloud Storage URI of the image.",
 "type": "string"
 },
 "imageText": {
@@ -5247,7 +5247,7 @@
 "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto"
 },
 "signatureValue": {
-"description": "A signature - a graphical representation of a person's name, often used to sign a document.",
+"description": "A signature, which is a graphical representation of a person's name, often used to sign a document.",
 "type": "boolean"
 },
 "text": {
@@ -5341,7 +5341,7 @@
 "properties": {
 "gcsManagedDocId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdGCSManagedDocumentId",
-"description": "A document id within user-managed Cloud Storage."
+"description": "A document ID within user-managed Cloud Storage."
 },
 "revisionRef": {
 "$ref": "GoogleCloudDocumentaiV1beta3RevisionRef",
@@ -5349,7 +5349,7 @@
 },
 "unmanagedDocId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
-"description": "A document id within unmanaged dataset."
+"description": "A document ID within unmanaged dataset."
 }
 },
 "type": "object"
@@ -5360,7 +5360,7 @@
 "properties": {
 "cwDocId": {
 "deprecated": true,
-"description": "Id of the document (indexed) managed by Content Warehouse.",
+"description": "ID of the document (indexed) managed by Content Warehouse.",
 "type": "string"
 },
 "gcsUri": {
@@ -5375,7 +5375,7 @@
 "id": "GoogleCloudDocumentaiV1beta3DocumentIdUnmanagedDocumentId",
 "properties": {
 "docId": {
-"description": "Required. The id of the document.",
+"description": "Required. The ID of the document.",
 "type": "string"
 }
 },
@@ -6197,7 +6197,7 @@
 "properties": {
 "id": {
 "deprecated": true,
-"description": "The Id of this operation. Needs to be unique within the scope of the revision.",
+"description": "The ID of this operation. Needs to be unique within the scope of the revision.",
 "format": "int32",
 "type": "integer"
 },
@@ -6257,7 +6257,7 @@ true
 "properties": {
 "id": {
 "deprecated": true,
-"description": "The id of the parent provenance.",
+"description": "The ID of the parent provenance.",
 "format": "int32",
 "type": "integer"
 },
@@ -6279,7 +6279,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3DocumentRevision",
 "properties": {
 "agent": {
-"description": "If the change was made by a person specify the name or id of that person.",
+"description": "If the change was made by a person specify the name or ID of that person.",
 "type": "string"
 },
 "createTime": {
@@ -6292,7 +6292,7 @@ true
 "description": "Human Review information of this revision."
 },
 "id": {
-"description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.",
+"description": "ID of the revision, internally generated by doc proto storage. Unique within the context of the document.",
 "type": "string"
 },
 "parent": {
@@ -6346,7 +6346,7 @@ true
 "type": "string"
 },
 "documentPrompt": {
-"description": "Optional. Document level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
+"description": "Optional. Document-level prompt provided by the user. This custom text is injected into the AI model's prompt to provide extra, document-wide guidance for processing.",
 "type": "string"
 },
 "entityTypes": {
@@ -6391,7 +6391,7 @@ true
 "description": "If specified, lists all the possible values for this entity. This should not be more than a handful of values. If the number of values is >10 or could change frequently, use the `EntityType.value_ontology` field and specify a list of all possible values in a value ontology file."
 },
 "name": {
-"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
+"description": "Name of the type. It must be unique within the schema file and cannot be a \"Common Type\". The following naming conventions are used: - Use `snake_casing`. - Name matching is case-sensitive. - Maximum 64 characters. - Must start with a letter. - Allowed characters: ASCII letters `[a-z0-9_-]`. (For backward compatibility, internal infrastructure and tooling can handle any ASCII character.) - The `/` is sometimes used to denote a property of a type. For example, `line_item/amount`. This convention is deprecated, but will still be honored for backward compatibility.",
 "type": "string"
 },
 "properties": {
@@ -7199,7 +7199,7 @@ true
 },
 "outputDocumentId": {
 "$ref": "GoogleCloudDocumentaiV1beta3DocumentId",
-"description": "The document id of imported document if it was successful, otherwise empty."
+"description": "The document ID of imported document if it was successful, otherwise empty."
 },
 "status": {
 "$ref": "GoogleRpcStatus",
@@ -7797,7 +7797,7 @@ true
 "id": "GoogleCloudDocumentaiV1beta3Processor",
 "properties": {
 "activeSchemaVersion": {
-"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}",
+"description": "Optional. SchemaVersion used by the Processor. It is the same as Processor's DatasetSchema.schema_version Format is `projects/{project}/locations/{location}/schemas/{schema}/schemaVersions/{schema_version}.",
 "type": "string"
 },
 "createTime": {
@@ -8581,7 +8581,7 @@ true
 "type": "number"
 },
 "previousFineTunedProcessorVersionName": {
-"description": "Optional. Resource name of a previously fine tuned version id to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
+"description": "Optional. Resource name of a previously fine tuned version ID to copy the overwritten configs from. The base_processor_version should be newer than the base processor version used to fine tune this provided processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`.",
 "type": "string"
 },
 "trainSteps": {
diff --git a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json
index 4af4ca7118..60c55821e2 100644
--- a/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebaseapphosting.v1beta.json
@@ -1138,7 +1138,7 @@
 }
 }
 },
-"revision": "20260618",
+"revision": "20260630",
 "rootUrl": "https://firebaseapphosting.googleapis.com/",
 "schemas": {
 "ArchiveSource": {
@@ -1299,7 +1299,7 @@
 "type": "object"
 },
 "BackendRuntime": {
-"description": "Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime \"nodejs\" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled.",
+"description": "Runtime is a string that represents the runtime that is used to build the backend. Users can specify one of the following runtimes: nodejs20, nodejs22, nodejs24, nodejs. Runtime \"nodejs\" means that nodejs version will be determined at build time. If not specified or specified with a value that is not in the list above, the default runtime `nodejs` will be used and Automatic Base Image Updates will be disabled. See [Firebase documentation](https://firebase.google.com/docs/app-hosting/frameworks-tooling#managing_runtime_versions) for more details.",
 "id": "BackendRuntime",
 "properties": {
 "value": {
diff --git a/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json b/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json
new file mode 100644
index 0000000000..bba6a31341
--- /dev/null
+++ b/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json
@@ -0,0 +1,1936 @@
+{
+"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/firebase": {
+"description": "View and administer all your Firebase data and settings"
+}
+}
+}
+},
+"basePath": "",
+"baseUrl": "https://firebasecrashlytics.googleapis.com/",
+"batchPath": "batch",
+"canonicalName": "Firebase Crashlytics",
+"description": "This service provides an API for mobile app developers to request deletion of user's crash reports.",
+"discoveryVersion": "v1",
+"documentationLink": "https://firebase.google.com/docs/crashlytics",
+"fullyEncodeReservedExpansion": true,
+"icons": {
+"x16": "http://www.google.com/images/icons/product/search-16.gif",
+"x32": "http://www.google.com/images/icons/product/search-32.gif"
+},
+"id": "firebasecrashlytics:v1alpha",
+"kind": "discovery#restDescription",
+"mtlsRootUrl": "https://firebasecrashlytics.mtls.googleapis.com/",
+"name": "firebasecrashlytics",
+"ownerDomain": "google.com",
+"ownerName": "Google",
+"parameters": {
+"$.xgafv": {
+"description": "V1 error format.",
+"enum": [
+"1",
+"2"
+],
+"enumDescriptions": [
+"v1 error format",
+"v2 error format"
+],
+"location": "query",
+"type": "string"
+},
+"access_token": {
+"description": "OAuth access token.",
+"location": "query",
+"type": "string"
+},
+"alt": {
+"default": "json",
+"description": "Data format for response.",
+"enum": [
+"json",
+"media",
+"proto"
+],
+"enumDescriptions": [
+"Responses with Content-Type of application/json",
+"Media download with context-dependent Content-Type",
+"Responses with Content-Type of application/x-protobuf"
+],
+"location": "query",
+"type": "string"
+},
+"callback": {
+"description": "JSONP",
+"location": "query",
+"type": "string"
+},
+"fields": {
+"description": "Selector specifying which fields to include in a partial response.",
+"location": "query",
+"type": "string"
+},
+"key": {
+"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
+"location": "query",
+"type": "string"
+},
+"oauth_token": {
+"description": "OAuth 2.0 token for the current user.",
+"location": "query",
+"type": "string"
+},
+"prettyPrint": {
+"default": "true",
+"description": "Returns response with indentations and line breaks.",
+"location": "query",
+"type": "boolean"
+},
+"quotaUser": {
+"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+"location": "query",
+"type": "string"
+},
+"uploadType": {
+"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+"location": "query",
+"type": "string"
+},
+"upload_protocol": {
+"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+"location": "query",
+"type": "string"
+}
+},
+"protocol": "rest",
+"resources": {
+"projects": {
+"resources": {
+"apps": {
+"resources": {
+"events": {
+"methods": {
+"batchGet": {
+"description": "Fetch a batch of up to 100 events by name.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/events:batchGet",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.events.batchGet",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"names": {
+"description": "Required. The resource names of the desired events. A maximum of 100 events can be retrieved in a batch. Format: \"projects/{project}/apps/{app_id}/events/{event_id}\". The app_id and event_id are required, but project may be \"-\" to conserve space in long URIs.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. The firebase application. Format: \"projects/{project}/apps/{app_id}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. The list of Event fields to include in the response. If omitted, the full event is returned.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/events:batchGet",
+"response": {
+"$ref": "BatchGetEventsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"list": {
+"description": "List the events for an issue matching filter criteria, sorted in descending order by timestamp.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/events",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.events.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"filter.browser.displayNames": {
+"description": "Optional. Only count events from the given browser. This string matches Browser.display_name. Format: \"name (display_version)\" e.g. \"Chrome (123)\", or just \"name\" for all possible versions, e.g. simply \"Chrome\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.device.displayNames": {
+"description": "Only counts events from the given Device model. This string matches Device.display_name. Format: \"manufacturer (model)\" e.g. \"Google (Pixel 6)\", or just \"manufacturer\" for all possible models, e.g. simply \"Google\". Note that a device's marketing_name field can not be used for filtering.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.device.formFactors": {
+"description": "Only counts events from devices with the given form factor (e.g. phone or tablet).",
+"enum": [
+"FORM_FACTOR_UNSPECIFIED",
+"PHONE",
+"TABLET",
+"DESKTOP",
+"TV",
+"WATCH"
+],
+"enumDescriptions": [
+"Unknown.",
+"Includes mobile phones, small foldables and other form factors not fitting the other categories.",
+"Includes tablets and larger foldables.",
+"Includes desktops, laptops, Chromebooks, etc.",
+"Includes televisions and set-tops.",
+"Includes both watches and other wearables."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.interval.endTime": {
+"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
+"filter.interval.startTime": {
+"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
+"filter.issue.content": {
+"description": "Optional. A space separated list of filter terms matched against the contents of the issue. Contents include the title and the stack trace. Matches must begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet' but not 'myutil.SortedArray'. The filter matches if all filter terms match. All non-alphanumeric characters are ignored for matching. Filtering is assumed to be prefix-search and order-independent unless phrases are surrounded by \"\". Any terms contained in quotes are searched using exact-match (given filter term \"foo\", we will not return \"foobar\"), and must appear in the order given exactly. To get order-dependence but prefix-search, use a * within the quotes (\"abc foo*\" will match \"abc foobar\", but not \"foo abc\" \"abcd foobar\", or \"abc xyz foobar\").",
+"location": "query",
+"type": "string"
+},
+"filter.issue.errorTypes": {
+"description": "Optional. Only counts events of the given error types. This field matches [Issue.error_type].",
+"enum": [
+"ERROR_TYPE_UNSPECIFIED",
+"FATAL",
+"NON_FATAL",
+"ANR"
+],
+"enumDescriptions": [
+"Unknown.",
+"Fatal crash event.",
+"Non-fatal event, such as a caught Java exception or NSError on iOS.",
+"Application not responding error, Android only."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.id": {
+"description": "Optional. Only counts events in the given issue ID. This field matches [Issue.id].",
+"location": "query",
+"type": "string"
+},
+"filter.issue.signals": {
+"description": "Optional. Only returns issues currently marked with the given signals. This field matches [Issue.signals.signal].",
+"enum": [
+"SIGNAL_UNSPECIFIED",
+"SIGNAL_EARLY",
+"SIGNAL_FRESH",
+"SIGNAL_REGRESSED",
+"SIGNAL_REPETITIVE"
+],
+"enumDescriptions": [
+"Default.",
+"Indicates an issue that is impacting end users early in the app session.",
+"Indicates newly detected issues.",
+"Indicates previously closed issues which have been detected again.",
+"Indicates issues impacting some end users multiple times."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.state": {
+"deprecated": true,
+"description": "Optional. Deprecated: Prefer `states` field. Only includes events for issues with the given issue state. Only available for `topIssues` reports.",
+"enum": [
+"STATE_UNSPECIFIED",
+"OPEN",
+"CLOSED",
+"MUTED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Ongoing issue.",
+"Issue resolved.",
+"Issue muted. No alerts will be fired for this issue."
+],
+"location": "query",
+"type": "string"
+},
+"filter.issue.states": {
+"description": "Optional. Only includes events for issues with the given issue states. Only available for `topIssues` reports.",
+"enum": [
+"STATE_UNSPECIFIED",
+"OPEN",
+"CLOSED",
+"MUTED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Ongoing issue.",
+"Issue resolved.",
+"Issue muted. No alerts will be fired for this issue."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.variantId": {
+"description": "Optional. Only counts events for the given issue variant ID. This field matches [IssueVariant.id].",
+"location": "query",
+"type": "string"
+},
+"filter.operatingSystem.displayNames": {
+"description": "Only counts events in the given operating system and version. This string matches OperatingSystem.display_name. Format: \"osName (osVersion)\" e.g. \"Android (11)\". or just \"osName\" for all versions, e.g. simply \"iPadOS\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.version.displayNames": {
+"description": "Only counts events in the given app version. This string matches Version.display_name. Format: \"display_version (build_version)\" e.g. \"1.2.3 (456)\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of events per page. If omitted, defaults to 10.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous calls.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The Firebase application. Format: \"projects/{project}/apps/{app_id}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+$",
+"required": true,
+"type": "string"
+},
+"readMask": {
+"description": "Optional. The list of Event fields to include in the response. If omitted, the full event is returned.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/events",
+"response": {
+"$ref": "ListEventsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+}
+}
+},
+"issues": {
+"methods": {
+"batchUpdate": {
+"description": "Change the state of a group of issues. This method is not atomic, so partial failures can occur. In the event of a partial failure, the request will fail and you will need to call `GetIssue` to see which issues were not updated.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues:batchUpdate",
+"httpMethod": "POST",
+"id": "firebasecrashlytics.projects.apps.issues.batchUpdate",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource shared by all issues being updated. Format: projects/{project}/apps/{app}. If this is set, the parent field in the UpdateIssueRequest messages must either be empty or match this field.",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/issues:batchUpdate",
+"request": {
+"$ref": "BatchUpdateIssuesRequest"
+},
+"response": {
+"$ref": "BatchUpdateIssuesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"get": {
+"description": "Retrieve an issue.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues/{issuesId}",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.issues.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the issue to retrieve. Format: \"projects/{project}/apps/{app}/issues/{issue}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/issues/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "Issue"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"patch": {
+"description": "Change the state of an issue.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues/{issuesId}",
+"httpMethod": "PATCH",
+"id": "firebasecrashlytics.projects.apps.issues.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Output only. Immutable. Identifier. The name of the issue resource. Format: \"projects/{project}/apps/{app}/issues/{issue}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/issues/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Optional. The list of Issue fields to update. Currently only \"state\" is mutable.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"request": {
+"$ref": "Issue"
+},
+"response": {
+"$ref": "Issue"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+}
+},
+"resources": {
+"notes": {
+"methods": {
+"create": {
+"description": "Create a new note for an issue.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues/{issuesId}/notes",
+"httpMethod": "POST",
+"id": "firebasecrashlytics.projects.apps.issues.notes.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource where this note will be created. Format: \"projects/{project}/apps/{app}/issues/{issue}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/issues/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/notes",
+"request": {
+"$ref": "Note"
+},
+"response": {
+"$ref": "Note"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"delete": {
+"description": "Delete a note by its name.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues/{issuesId}/notes/{notesId}",
+"httpMethod": "DELETE",
+"id": "firebasecrashlytics.projects.apps.issues.notes.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the note to delete. Format: projects/{project}/apps/{app}/issues/{issue}/notes/{note}.",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/issues/[^/]+/notes/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "Empty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"list": {
+"description": "List all notes for a certain issue, sorted in descending order by timestamp.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/issues/{issuesId}/notes",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.issues.notes.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Optional. The maximum number of notes per page. If omitted, defaults to 10.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous calls.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The issue the notes belongs to. Format: \"projects/{project}/apps/{app}/issues/{issue}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/issues/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/notes",
+"response": {
+"$ref": "ListNotesResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+}
+}
+}
+}
+},
+"reports": {
+"methods": {
+"get": {
+"description": "Get a report with its computed results.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/reports/{reportsId}",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.reports.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter.browser.displayNames": {
+"description": "Optional. Only count events from the given browser. This string matches Browser.display_name. Format: \"name (display_version)\" e.g. \"Chrome (123)\", or just \"name\" for all possible versions, e.g. simply \"Chrome\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.device.displayNames": {
+"description": "Only counts events from the given Device model. This string matches Device.display_name. Format: \"manufacturer (model)\" e.g. \"Google (Pixel 6)\", or just \"manufacturer\" for all possible models, e.g. simply \"Google\". Note that a device's marketing_name field can not be used for filtering.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.device.formFactors": {
+"description": "Only counts events from devices with the given form factor (e.g. phone or tablet).",
+"enum": [
+"FORM_FACTOR_UNSPECIFIED",
+"PHONE",
+"TABLET",
+"DESKTOP",
+"TV",
+"WATCH"
+],
+"enumDescriptions": [
+"Unknown.",
+"Includes mobile phones, small foldables and other form factors not fitting the other categories.",
+"Includes tablets and larger foldables.",
+"Includes desktops, laptops, Chromebooks, etc.",
+"Includes televisions and set-tops.",
+"Includes both watches and other wearables."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.interval.endTime": {
+"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
+"filter.interval.startTime": {
+"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.",
+"format": "google-datetime",
+"location": "query",
+"type": "string"
+},
+"filter.issue.content": {
+"description": "Optional. A space separated list of filter terms matched against the contents of the issue. Contents include the title and the stack trace. Matches must begin at alphanumeric tokens, i.e., 'util.Sorted' matches 'java.util.SortedSet' but not 'myutil.SortedArray'. The filter matches if all filter terms match. All non-alphanumeric characters are ignored for matching. Filtering is assumed to be prefix-search and order-independent unless phrases are surrounded by \"\". Any terms contained in quotes are searched using exact-match (given filter term \"foo\", we will not return \"foobar\"), and must appear in the order given exactly. To get order-dependence but prefix-search, use a * within the quotes (\"abc foo*\" will match \"abc foobar\", but not \"foo abc\" \"abcd foobar\", or \"abc xyz foobar\").",
+"location": "query",
+"type": "string"
+},
+"filter.issue.errorTypes": {
+"description": "Optional. Only counts events of the given error types. This field matches [Issue.error_type].",
+"enum": [
+"ERROR_TYPE_UNSPECIFIED",
+"FATAL",
+"NON_FATAL",
+"ANR"
+],
+"enumDescriptions": [
+"Unknown.",
+"Fatal crash event.",
+"Non-fatal event, such as a caught Java exception or NSError on iOS.",
+"Application not responding error, Android only."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.id": {
+"description": "Optional. Only counts events in the given issue ID. This field matches [Issue.id].",
+"location": "query",
+"type": "string"
+},
+"filter.issue.signals": {
+"description": "Optional. Only returns issues currently marked with the given signals. This field matches [Issue.signals.signal].",
+"enum": [
+"SIGNAL_UNSPECIFIED",
+"SIGNAL_EARLY",
+"SIGNAL_FRESH",
+"SIGNAL_REGRESSED",
+"SIGNAL_REPETITIVE"
+],
+"enumDescriptions": [
+"Default.",
+"Indicates an issue that is impacting end users early in the app session.",
+"Indicates newly detected issues.",
+"Indicates previously closed issues which have been detected again.",
+"Indicates issues impacting some end users multiple times."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.state": {
+"deprecated": true,
+"description": "Optional. Deprecated: Prefer `states` field. Only includes events for issues with the given issue state. Only available for `topIssues` reports.",
+"enum": [
+"STATE_UNSPECIFIED",
+"OPEN",
+"CLOSED",
+"MUTED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Ongoing issue.",
+"Issue resolved.",
+"Issue muted. No alerts will be fired for this issue."
+],
+"location": "query",
+"type": "string"
+},
+"filter.issue.states": {
+"description": "Optional. Only includes events for issues with the given issue states. Only available for `topIssues` reports.",
+"enum": [
+"STATE_UNSPECIFIED",
+"OPEN",
+"CLOSED",
+"MUTED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Ongoing issue.",
+"Issue resolved.",
+"Issue muted. No alerts will be fired for this issue."
+],
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.issue.variantId": {
+"description": "Optional. Only counts events for the given issue variant ID. This field matches [IssueVariant.id].",
+"location": "query",
+"type": "string"
+},
+"filter.operatingSystem.displayNames": {
+"description": "Only counts events in the given operating system and version. This string matches OperatingSystem.display_name. Format: \"osName (osVersion)\" e.g. \"Android (11)\". or just \"osName\" for all versions, e.g. simply \"iPadOS\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"filter.version.displayNames": {
+"description": "Only counts events in the given app version. This string matches Version.display_name. Format: \"display_version (build_version)\" e.g. \"1.2.3 (456)\".",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"granularity": {
+"description": "Optional. The report response will contain one data point per time grain. If omitted, the report will contain a single data point for the complete interval.",
+"enum": [
+"TIME_GRANULARITY_UNSPECIFIED",
+"TIME_GRANULARITY_NONE",
+"TIME_GRANULARITY_HOUR",
+"TIME_GRANULARITY_DAY"
+],
+"enumDescriptions": [
+"Unknown.",
+"Returns a single interval for the requested time range.",
+"Hour.",
+"Day."
+],
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "Required. The report name. Format: \"projects/{project}/apps/{app_id}/reports/{report}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/reports/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "Optional. The maximum number of result groups to return. If omitted, defaults to 25.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "Optional. A page token, received from a previous call. The page token is only valid for the exact same set of filters, which must also be sent in subsequent requests. This token is valid for 10 minutes after the first request.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "Report"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+},
+"list": {
+"description": "List all of the available reports.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/reports",
+"httpMethod": "GET",
+"id": "firebasecrashlytics.projects.apps.reports.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The firebase application. Format: \"projects/{project}/apps/{app_id}\".",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/reports",
+"response": {
+"$ref": "ListReportsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+}
+}
+},
+"users": {
+"methods": {
+"deleteCrashReports": {
+"description": "Enqueues a request to permanently remove crash reports associated with the specified user. All reports belonging to the specified user will be deleted typically within 24 hours of receiving the crash report.",
+"flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/users/{usersId}/crashReports",
+"httpMethod": "DELETE",
+"id": "firebasecrashlytics.projects.apps.users.deleteCrashReports",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name for user reports, in the format: projects/ PROJECT_IDENTIFIER/apps/APP_ID/users/USER_ID/crashReports - PROJECT_IDENTIFIER: The Firebase project's project number (recommended) or its project ID. Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - APP_ID: The globally unique, Firebase-assigned identifier for the Firebase App. This is not your package name or bundle ID. Learn how to [find your app ID](https://firebase.google.com/support/faq/#find-app-id). - USER_ID: The user ID set using the Crashlytics SDK. Learn how to [set user identifiers](https://firebase.google.com/docs/crashlytics/customize-crash-reports#set-user-ids).",
+"location": "path",
+"pattern": "^projects/[^/]+/apps/[^/]+/users/[^/]+/crashReports$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "DeleteUserCrashReportsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/firebase"
+]
+}
+}
+}
+}
+}
+}
+}
+},
+"revision": "20260710",
+"rootUrl": "https://firebasecrashlytics.googleapis.com/",
+"schemas": {
+"BatchGetEventsResponse": {
+"description": "Response message for the BatchGetEvents method.",
+"id": "BatchGetEventsResponse",
+"properties": {
+"events": {
+"description": "The list of retrieved events.",
+"items": {
+"$ref": "Event"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"BatchUpdateIssuesRequest": {
+"description": "Request message for the BatchUpdateIssues method.",
+"id": "BatchUpdateIssuesRequest",
+"properties": {
+"requests": {
+"description": "Required. The request message specifying the resources to update. A maximum of 100 issues can be modified in a batch.",
+"items": {
+"$ref": "UpdateIssueRequest"
+},
+"type": "array"
+},
+"updateMask": {
+"description": "Optional. The list of Issue fields to update. If this is set, the update_mask field in the UpdateIssueRequest messages must either be empty or match this field.",
+"format": "google-fieldmask",
+"type": "string"
+}
+},
+"type": "object"
+},
+"BatchUpdateIssuesResponse": {
+"description": "Response message for the BatchUpdateIssues method.",
+"id": "BatchUpdateIssuesResponse",
+"properties": {
+"issues": {
+"description": "Issues updated in the same order as in BatchUpdateIssuesRequest.",
+"items": {
+"$ref": "Issue"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"Breadcrumb": {
+"description": "Analytics events recorded during the session.",
+"id": "Breadcrumb",
+"properties": {
+"eventTime": {
+"description": "Device timestamp for the event.",
+"format": "google-datetime",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Event parameters.",
+"type": "object"
+},
+"title": {
+"description": "Analytic event name.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Browser": {
+"description": "Web browser metadata.",
+"id": "Browser",
+"properties": {
+"browser": {
+"description": "Browser name.",
+"type": "string"
+},
+"displayName": {
+"description": "Browser name and version number. Formatted to be suitable for passing to BrowserFilter.",
+"type": "string"
+},
+"displayVersion": {
+"description": "Browser display version number.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"DeleteUserCrashReportsResponse": {
+"description": "Response message for the DeleteUserCrashReports method. All crash reports associated with the specified user will be deleted typically within 24 hours of receiving the crash report.",
+"id": "DeleteUserCrashReportsResponse",
+"properties": {
+"targetCompleteTime": {
+"description": "Target time to complete the delete crash reports operation.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Device": {
+"description": "Mobile device metadata.",
+"id": "Device",
+"properties": {
+"architecture": {
+"description": "Device processor architecture.",
+"type": "string"
+},
+"companyName": {
+"description": "An invariant name of the manufacturer that submitted this product in its most recognizable public form, e.g. \"Google\".",
+"type": "string"
+},
+"displayName": {
+"description": "Full device name, suitable for passing to DeviceFilter. Format: \"manufacturer (model)\".",
+"type": "string"
+},
+"formFactor": {
+"description": "See FormFactor message.",
+"enum": [
+"FORM_FACTOR_UNSPECIFIED",
+"PHONE",
+"TABLET",
+"DESKTOP",
+"TV",
+"WATCH"
+],
+"enumDescriptions": [
+"Unknown.",
+"Includes mobile phones, small foldables and other form factors not fitting the other categories.",
+"Includes tablets and larger foldables.",
+"Includes desktops, laptops, Chromebooks, etc.",
+"Includes televisions and set-tops.",
+"Includes both watches and other wearables."
+],
+"type": "string"
+},
+"manufacturer": {
+"description": "Device brand name which is consistent with android.os.Build.BRAND.",
+"type": "string"
+},
+"marketingName": {
+"description": "Marketing name, most recognizable public form, e.g. \"Pixel 6\".",
+"type": "string"
+},
+"model": {
+"description": "The model name which is consistent with android.os.Build.MODEL, e.g. (\"SPH-L710\", \"GT-I9300\").",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Empty": {
+"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",
+"properties": {},
+"type": "object"
+},
+"Error": {
+"description": "A non-fatal error and its stacktrace, only from Apple apps.",
+"id": "Error",
+"properties": {
+"blamed": {
+"description": "True when the Crashlytics analysis has determined that the stacktrace in this error is where the fault occurred.",
+"type": "boolean"
+},
+"code": {
+"description": "Error code associated with the app's custom logged NSError.",
+"format": "int64",
+"type": "string"
+},
+"frames": {
+"description": "The frames in the error's stacktrace.",
+"items": {
+"$ref": "Frame"
+},
+"type": "array"
+},
+"queue": {
+"description": "The queue on which the thread was running.",
+"type": "string"
+},
+"subtitle": {
+"description": "The subtitle of the error.",
+"type": "string"
+},
+"title": {
+"description": "The title of the error.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Event": {
+"description": "The message describing a single Crashlytics event. Related to BigQuery export schema, which can be found at [Export Crashlytics data to BigQuery](https://firebase.google.com/docs/crashlytics/bigquery-export#dataset-schema-crashlytics)",
+"id": "Event",
+"properties": {
+"appOrientation": {
+"description": "App orientation at the time of the crash (portrait or landscape).",
+"type": "string"
+},
+"blameFrame": {
+"$ref": "Frame",
+"description": "The stack trace frame blamed by Crashlytics processing. May not be present in future analyzer."
+},
+"breadcrumbs": {
+"description": "Analytics events recorded by the analytics SDK during the session.",
+"items": {
+"$ref": "Breadcrumb"
+},
+"type": "array"
+},
+"browser": {
+"$ref": "Browser",
+"description": "Browser and version."
+},
+"buildStamp": {
+"description": "Metadata provided by the app's build system, including version control repository info.",
+"type": "string"
+},
+"bundleOrPackage": {
+"description": "The bundle name for iOS apps or the package name of Android apps. Format: \"com.mycompany.myapp\".",
+"type": "string"
+},
+"crashlyticsSdkVersion": {
+"description": "Crashlytics SDK version.",
+"type": "string"
+},
+"customKeys": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "Custom keys set by the developer during the session.",
+"type": "object"
+},
+"device": {
+"$ref": "Device",
+"description": "Mobile device metadata."
+},
+"deviceOrientation": {
+"description": "Device orientation at the time of the crash (portrait or landscape).",
+"type": "string"
+},
+"errors": {
+"description": "Apple only. A non-fatal error captured by the iOS SDK and its stacktrace.",
+"items": {
+"$ref": "Error"
+},
+"type": "array"
+},
+"eventId": {
+"description": "Output only. Immutable. The unique event identifier is assigned during processing.",
+"readOnly": true,
+"type": "string"
+},
+"eventTime": {
+"description": "Device timestamp that the event was recorded.",
+"format": "google-datetime",
+"type": "string"
+},
+"exceptions": {
+"description": "Android and web only. Exceptions that occurred during this event. Nested exceptions are presented in reverse chronological order, so that the last record is the first exception thrown.",
+"items": {
+"$ref": "Exception"
+},
+"type": "array"
+},
+"installationUuid": {
+"description": "Unique identifier for the device-app installation. This field is used to compute the unique number of impacted users.",
+"type": "string"
+},
+"issue": {
+"$ref": "Issue",
+"description": "Details for the [Issue] assigned to this [Event]."
+},
+"issueSubtitle": {
+"description": "The subtitle of the issue in which the event was grouped. This is usually a symbol or an exception message.",
+"type": "string"
+},
+"issueTitle": {
+"description": "The title of the issue in which the event was grouped. This is usually a source file or method name.",
+"type": "string"
+},
+"issueVariant": {
+"$ref": "IssueVariant",
+"description": "Details for the [IssueVariant] assigned to this [Event]."
+},
+"logs": {
+"description": "Log messages recorded by the developer during the session.",
+"items": {
+"$ref": "Log"
+},
+"type": "array"
+},
+"memory": {
+"$ref": "Memory",
+"description": "Mobile device memory usage."
+},
+"name": {
+"description": "Required. Output only. Immutable. Identifier. The name of the event resource. Format: \"projects/{project}/apps/{app_id}/events/{event}\".",
+"readOnly": true,
+"type": "string"
+},
+"operatingSystem": {
+"$ref": "OperatingSystem",
+"description": "Operating system and version."
+},
+"platform": {
+"description": "ANDROID, IOS, or WEB.",
+"type": "string"
+},
+"processState": {
+"description": "The state of the app process at the time of the event.",
+"type": "string"
+},
+"receivedTime": {
+"description": "Server timestamp that the event was received by Crashlytics.",
+"format": "google-datetime",
+"type": "string"
+},
+"routePath": {
+"description": "Output only. Web only. The route path of the web application when the event occurred, excluding query parameters and fragment.",
+"readOnly": true,
+"type": "string"
+},
+"sessionId": {
+"description": "Unique identifier for the Firebase session.",
+"type": "string"
+},
+"storage": {
+"$ref": "Storage",
+"description": "Mobile device disk/flash usage."
+},
+"threads": {
+"description": "Application threads present at the time the event was recorded. Each contains a stacktrace. One thread will be blamed for the error.",
+"items": {
+"$ref": "Thread"
+},
+"type": "array"
+},
+"user": {
+"$ref": "User",
+"description": "End user identifiers for the device owner."
+},
+"version": {
+"$ref": "Version",
+"description": "Mobile application version."
+}
+},
+"type": "object"
+},
+"Exception": {
+"description": "A Java or Javascript exception and its stacktrace. Only from Android or web apps.",
+"id": "Exception",
+"properties": {
+"blamed": {
+"description": "True when the Crashlytics analysis has determined that this thread is where the fault occurred.",
+"type": "boolean"
+},
+"exceptionMessage": {
+"description": "A message associated with the exception.",
+"type": "string"
+},
+"frames": {
+"description": "The frames in the exception's stacktrace.",
+"items": {
+"$ref": "Frame"
+},
+"type": "array"
+},
+"nested": {
+"description": "True for all but the last-thrown exception (i.e. the first record).",
+"type": "boolean"
+},
+"subtitle": {
+"description": "The subtitle of the exception.",
+"type": "string"
+},
+"title": {
+"description": "The title of the exception.",
+"type": "string"
+},
+"type": {
+"description": "The exception type e.g. java.lang.IllegalStateException.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"FirebaseSessionEvent": {
+"description": "Sessions recorded by the Firebase App Quality Sessions SDK.",
+"id": "FirebaseSessionEvent",
+"properties": {
+"device": {
+"$ref": "Device",
+"description": "Mobile device metadata."
+},
+"eventTime": {
+"description": "The start timestamp for the session event.",
+"format": "google-datetime",
+"type": "string"
+},
+"eventType": {
+"description": "Session event type. The SDK only supports SESSION_START events at this time.",
+"enum": [
+"SESSION_EVENT_TYPE_UNKNOWN",
+"SESSION_START"
+],
+"enumDescriptions": [
+"Unknown.",
+"Application session started."
+],
+"type": "string"
+},
+"firebaseInstallationId": {
+"description": "Uniquely identifies a device with Firebase apps installed.",
+"type": "string"
+},
+"firstSessionId": {
+"description": "The identifier of the first session since the last cold start. This id and the session_id will be the same for app launches.",
+"type": "string"
+},
+"operatingSystem": {
+"$ref": "OperatingSystem",
+"description": "Operating system and version."
+},
+"sessionId": {
+"description": "Unique identifier for the Firebase session.",
+"type": "string"
+},
+"sessionIndex": {
+"description": "Indicates the number of sessions since the last cold start.",
+"format": "int32",
+"type": "integer"
+},
+"version": {
+"$ref": "Version",
+"description": "Mobile application version numbers."
+}
+},
+"type": "object"
+},
+"Frame": {
+"description": "A frame in a stacktrace.",
+"id": "Frame",
+"properties": {
+"address": {
+"description": "The address in the binary image which contains the code. Present for native frames.",
+"format": "int64",
+"type": "string"
+},
+"blamed": {
+"description": "True when the Crashlytics analysis has determined that this frame is likely to be the cause of the error.",
+"type": "boolean"
+},
+"column": {
+"description": "The column on the line.",
+"format": "int64",
+"type": "string"
+},
+"file": {
+"description": "The name of the source file in which the frame is found.",
+"type": "string"
+},
+"library": {
+"description": "The display name of the library that includes the frame.",
+"type": "string"
+},
+"line": {
+"description": "The line number in the file of the frame.",
+"format": "int64",
+"type": "string"
+},
+"offset": {
+"description": "The byte offset into the binary image that contains the code. Present for native frames.",
+"format": "int64",
+"type": "string"
+},
+"owner": {
+"description": "One of DEVELOPER, VENDOR, RUNTIME, PLATFORM, or SYSTEM.",
+"type": "string"
+},
+"symbol": {
+"description": "The frame symbol after it has been deobfuscated or symbolicated. The raw symbol from the device if it could not be hydrated.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"IntervalMetrics": {
+"description": "A set of computed metric values for a time interval",
+"id": "IntervalMetrics",
+"properties": {
+"endTime": {
+"description": "The end of the interval covered by the computation.",
+"format": "google-datetime",
+"type": "string"
+},
+"eventsCount": {
+"description": "The total count of events in the interval.",
+"format": "int64",
+"type": "string"
+},
+"impactedUsersCount": {
+"description": "The number of distinct users in the set of events.",
+"format": "int64",
+"type": "string"
+},
+"sessionsCount": {
+"description": "The number of distinct sessions in the set of events.",
+"format": "int64",
+"type": "string"
+},
+"startTime": {
+"description": "The start of the interval covered by the computation.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Issue": {
+"description": "An issue describes a set of similar events that have been analyzed by Crashlytics and grouped together. All events within an issue will be of the same error_type: crash, non-fatal exception or ANR. All events within an issue will contain similar stack traces in their blamed thread.",
+"id": "Issue",
+"properties": {
+"errorType": {
+"description": "Output only. Immutable. Indicates whether this issue is a crash, non-fatal exception, or ANR.",
+"enum": [
+"ERROR_TYPE_UNSPECIFIED",
+"FATAL",
+"NON_FATAL",
+"ANR"
+],
+"enumDescriptions": [
+"Unknown.",
+"Fatal crash event.",
+"Non-fatal event, such as a caught Java exception or NSError on iOS.",
+"Application not responding error, Android only."
+],
+"readOnly": true,
+"type": "string"
+},
+"firstSeenTime": {
+"description": "Output only. Immutable. The first time this issue was seen.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"firstSeenVersion": {
+"description": "Output only. Immutable. The first app display_version in which this issue was seen, populated for mobile issues only.",
+"readOnly": true,
+"type": "string"
+},
+"id": {
+"description": "Output only. Immutable. Unique identifier for the issue.",
+"readOnly": true,
+"type": "string"
+},
+"lastSeenTime": {
+"description": "Output only. The most recent time this issue was seen.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"lastSeenVersion": {
+"description": "Output only. The most recent app display_version in which this issue was seen, populated for mobile issues only.",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Required. Output only. Immutable. Identifier. The name of the issue resource. Format: \"projects/{project}/apps/{app}/issues/{issue}\".",
+"readOnly": true,
+"type": "string"
+},
+"notesCount": {
+"description": "Output only. The number of notes attached to an issue.",
+"format": "int64",
+"readOnly": true,
+"type": "string"
+},
+"sampleEvent": {
+"description": "Output only. The resource name for a sample event in this issue.",
+"readOnly": true,
+"type": "string"
+},
+"signals": {
+"description": "Output only. Immutable. Distinctive characteristics assigned by the Crashlytics analyzer.",
+"items": {
+"$ref": "IssueSignals"
+},
+"readOnly": true,
+"type": "array"
+},
+"state": {
+"description": "Output only. Indicates whether this issue is open, closed or muted. For details on how issue states change without user actions, see [Regressed Issues](https://firebase.google.com/docs/crashlytics/troubleshooting?platform=ios#regressed-issues).",
+"enum": [
+"STATE_UNSPECIFIED",
+"OPEN",
+"CLOSED",
+"MUTED"
+],
+"enumDescriptions": [
+"Unknown.",
+"Ongoing issue.",
+"Issue resolved.",
+"Issue muted. No alerts will be fired for this issue."
+],
+"readOnly": true,
+"type": "string"
+},
+"stateUpdateTime": {
+"description": "Output only. The time at which the issue state was last changed.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"subtitle": {
+"description": "Output only. Immutable. Caption subtitle. This is usually a symbol or an exception message.",
+"readOnly": true,
+"type": "string"
+},
+"title": {
+"description": "Output only. Immutable. Caption title. This is usually a source file or method name.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Output only. Provides a link to the Issue on the Firebase console. When this Issue is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.",
+"readOnly": true,
+"type": "string"
+},
+"variants": {
+"description": "Output only. Immutable. The top 12 variants (subgroups) within the issue. Variants group events within an issue that are very similar. A single result implies that the variant is the same as the parent issue. This field will be empty when multiple issues are requested. Request a single issue to list variants.",
+"items": {
+"$ref": "IssueVariant"
+},
+"readOnly": true,
+"type": "array"
+}
+},
+"type": "object"
+},
+"IssueSignals": {
+"description": "Distinctive characteristics assigned by the Crashlytics analyzer.",
+"id": "IssueSignals",
+"properties": {
+"description": {
+"description": "Output only. Supporting detail information.",
+"readOnly": true,
+"type": "string"
+},
+"signal": {
+"description": "Output only. The signal name.",
+"enum": [
+"SIGNAL_UNSPECIFIED",
+"SIGNAL_EARLY",
+"SIGNAL_FRESH",
+"SIGNAL_REGRESSED",
+"SIGNAL_REPETITIVE"
+],
+"enumDescriptions": [
+"Default.",
+"Indicates an issue that is impacting end users early in the app session.",
+"Indicates newly detected issues.",
+"Indicates previously closed issues which have been detected again.",
+"Indicates issues impacting some end users multiple times."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"IssueVariant": {
+"description": "A variant is a subgroup of an issue where all events have very similar stack traces. Issues may contain one or more variants.",
+"id": "IssueVariant",
+"properties": {
+"id": {
+"description": "Output only. Immutable. Distinct identifier for the variant.",
+"readOnly": true,
+"type": "string"
+},
+"sampleEvent": {
+"description": "Output only. The resource name for a sample event in this variant.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Output only. Provides a link to the variant on the Firebase console. When this variant is obtained as part of a Report, then the link will be configured with the same time interval and filters as the request.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"ListEventsResponse": {
+"description": "Response message for the ListEvents method.",
+"id": "ListEventsResponse",
+"properties": {
+"events": {
+"description": "Returns one element per event, in descending order the by event timestamp.",
+"items": {
+"$ref": "Event"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A pagination token to retrieve the next page of events. The next page will have earlier or later events depending on the request's ordering. If this field is not present, there are no subsequent events.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ListNotesResponse": {
+"description": "Response message for the ListNotes method.",
+"id": "ListNotesResponse",
+"properties": {
+"nextPageToken": {
+"description": "A pagination token to retrieve the next page of notes. If this field is not present, there are no subsequent notes.",
+"type": "string"
+},
+"notes": {
+"description": "Returns notes ordered descending by the timestamp.",
+"items": {
+"$ref": "Note"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"ListReportsResponse": {
+"description": "Response method for the ListReports method. The response will always include all of the available reports.",
+"id": "ListReportsResponse",
+"properties": {
+"reports": {
+"description": "The report objects returned will contain their names and usage instructions, but include no results. Use the `GetReport` method to run the report and obtain the paged results.",
+"items": {
+"$ref": "Report"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"Log": {
+"description": "Developer-provided log lines recorded during the session.",
+"id": "Log",
+"properties": {
+"logTime": {
+"description": "Device timestamp when the line was logged.",
+"format": "google-datetime",
+"type": "string"
+},
+"message": {
+"description": "Log message.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Memory": {
+"description": "Mobile device memory usage.",
+"id": "Memory",
+"properties": {
+"free": {
+"description": "Bytes free.",
+"format": "int64",
+"type": "string"
+},
+"used": {
+"description": "Bytes in use.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Note": {
+"description": "Developer notes for an issue.",
+"id": "Note",
+"properties": {
+"author": {
+"description": "Output only. The email of the author of the note.",
+"readOnly": true,
+"type": "string"
+},
+"body": {
+"description": "Immutable. The body of the note.",
+"type": "string"
+},
+"createTime": {
+"description": "Output only. Time when the note was created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. Identifier. Format: \"projects/{project}/apps/app/issues/{issue}/notes/{note}\".",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"OperatingSystem": {
+"description": "Mobile device operating system metadata.",
+"id": "OperatingSystem",
+"properties": {
+"deviceType": {
+"description": "The device category (mobile, tablet, desktop).",
+"type": "string"
+},
+"displayName": {
+"description": "Name and version number. Formatted to be suitable for passing to OperatingSystemFilter.",
+"type": "string"
+},
+"displayVersion": {
+"description": "Operating system display version number.",
+"type": "string"
+},
+"modificationState": {
+"description": "Indicates if the OS has been modified or \"jailbroken\".",
+"type": "string"
+},
+"os": {
+"description": "Operating system name.",
+"type": "string"
+},
+"type": {
+"description": "The OS type on Apple platforms (iOS, iPadOS, etc.).",
+"type": "string"
+}
+},
+"type": "object"
+},
+"PlayTrack": {
+"description": "Describes a release track in the Play Developer Console.",
+"id": "PlayTrack",
+"properties": {
+"title": {
+"description": "User-generated or auto-generated name of the track. PROD and INTERNAL track types always have auto-generated names, e.g. \"prod\" and \"internal\" respectively. Tracks of type EARLY_ACCESS always have a user-generated name. Other track types do not have any guarantees, might have user-generated or auto-generated names.",
+"type": "string"
+},
+"type": {
+"description": "The type of track (prod, internal, etc...).",
+"enum": [
+"TRACK_TYPE_UNSPECIFIED",
+"TRACK_TYPE_PROD",
+"TRACK_TYPE_INTERNAL",
+"TRACK_TYPE_OPEN_TESTING",
+"TRACK_TYPE_CLOSED_TESTING",
+"TRACK_TYPE_EARLY_ACCESS"
+],
+"enumDescriptions": [
+"Unknown.",
+"Production.",
+"Internal testing.",
+"Open testing.",
+"Closed testing.",
+"Early access."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"Report": {
+"description": "Response message for the GetReport method. A report consists of the results of a query over an application's events. The events may be filtered by various criteria defined in the filters proto. The result will consist of a number of paginated groups, of a type relevant to the report such as issues or device models.",
+"id": "Report",
+"properties": {
+"displayName": {
+"description": "Output only. The displayable title of the report.",
+"readOnly": true,
+"type": "string"
+},
+"groups": {
+"description": "Aggregate event statistics in the report will be grouped by a dimension, such as by issue or by version. The response contains one element per group, and all ReportGroup messages will have the same parent field.",
+"items": {
+"$ref": "ReportGroup"
+},
+"type": "array"
+},
+"name": {
+"description": "The name of the report. Format: \"projects/{project}/apps/{app_id}/reports/{report}\".",
+"type": "string"
+},
+"nextPageToken": {
+"description": "Output only. A page token used to retrieve additional report groups. If this field is not present, there are no subsequent pages available to retrieve.",
+"readOnly": true,
+"type": "string"
+},
+"totalSize": {
+"description": "Output only. The total number of groups retrievable by the request.",
+"format": "int32",
+"readOnly": true,
+"type": "integer"
+},
+"usage": {
+"description": "Usage instructions for the report with a description of the result metrics. This field contains a description of the underlying query and describes the expected response data with any known caveats. This string can be displayed in the UI of any integration that offers comprehensive access to all Crashlytics reports.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"ReportGroup": {
+"description": "A group of results in an EventReport. In any report, the group_parent field is strictly the same type for all of the groups in any collection.",
+"id": "ReportGroup",
+"properties": {
+"browser": {
+"$ref": "Browser",
+"description": "Browser metrics group."
+},
+"device": {
+"$ref": "Device",
+"description": "Device metrics group."
+},
+"issue": {
+"$ref": "Issue",
+"description": "Issue metrics group."
+},
+"metrics": {
+"description": "Scalar metrics will contain a single object covering the entire interval, while time-dimensioned graphs will contain one per time grain.",
+"items": {
+"$ref": "IntervalMetrics"
+},
+"type": "array"
+},
+"operatingSystem": {
+"$ref": "OperatingSystem",
+"description": "Operating system metrics group."
+},
+"subgroups": {
+"description": "When applicable, this field contains additional nested groupings. For example, events can be grouped by operating system and by operating system version.",
+"items": {
+"$ref": "ReportGroup"
+},
+"type": "array"
+},
+"variant": {
+"$ref": "IssueVariant",
+"description": "Issue variant metrics group."
+},
+"version": {
+"$ref": "Version",
+"description": "Version metrics group."
+},
+"webMetricsGroup": {
+"$ref": "WebMetricsGroup",
+"description": "Web metrics group."
+}
+},
+"type": "object"
+},
+"Storage": {
+"description": "Mobile device disk/flash usage. Not reported for all devices.",
+"id": "Storage",
+"properties": {
+"free": {
+"description": "Bytes free.",
+"format": "int64",
+"type": "string"
+},
+"used": {
+"description": "Bytes used.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Thread": {
+"description": "An application thread.",
+"id": "Thread",
+"properties": {
+"blamed": {
+"description": "True when the Crashlytics analysis has determined that the stacktrace in this thread is where the fault occurred.",
+"type": "boolean"
+},
+"crashAddress": {
+"description": "The address of the signal that caused the application to crash. Only present on crashed native threads.",
+"format": "int64",
+"type": "string"
+},
+"crashed": {
+"description": "True when the thread has crashed.",
+"type": "boolean"
+},
+"frames": {
+"description": "The frames in the thread's stacktrace.",
+"items": {
+"$ref": "Frame"
+},
+"type": "array"
+},
+"name": {
+"description": "The name of the thread.",
+"type": "string"
+},
+"queue": {
+"description": "The queue on which the thread was running.",
+"type": "string"
+},
+"signal": {
+"description": "The name of the signal that caused the app to crash. Only present on crashed native threads.",
+"type": "string"
+},
+"signalCode": {
+"description": "The code of the signal that caused the app to crash. Only present on crashed native threads.",
+"type": "string"
+},
+"subtitle": {
+"description": "The subtitle of the thread.",
+"type": "string"
+},
+"sysThreadId": {
+"description": "The system id of the thread, only available for ANR threads.",
+"format": "int64",
+"type": "string"
+},
+"threadId": {
+"description": "The id of the thread, only available for ANR threads.",
+"format": "int64",
+"type": "string"
+},
+"threadState": {
+"description": "Output only. The state of the thread at the time the ANR occurred.",
+"enum": [
+"STATE_UNSPECIFIED",
+"THREAD_STATE_TERMINATED",
+"THREAD_STATE_RUNNABLE",
+"THREAD_STATE_TIMED_WAITING",
+"THREAD_STATE_BLOCKED",
+"THREAD_STATE_WAITING",
+"THREAD_STATE_NEW",
+"THREAD_STATE_NATIVE_RUNNABLE",
+"THREAD_STATE_NATIVE_WAITING"
+],
+"enumDescriptions": [
+"Thread state unspecified.",
+"Thread was terminated.",
+"Thread was runnable.",
+"Thread was waiting with a timeout.",
+"Thread was blocked.",
+"Thread was waiting.",
+"Thread was started, yet to run anything.",
+"The thread was native and we could not heuristically determine that it was was waiting, so assume it's runnable.",
+"We heuristically determined that the thread is waiting."
+],
+"readOnly": true,
+"type": "string"
+},
+"title": {
+"description": "The title of the thread.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"UpdateIssueRequest": {
+"description": "Request message for the UpdateIssue method.",
+"id": "UpdateIssueRequest",
+"properties": {
+"issue": {
+"$ref": "Issue",
+"description": "Required. The issue to update. The issue's `name` field is used to identify the issue to update. Format: \"projects/{project}/apps/{app}/issues/{issue}\"."
+},
+"updateMask": {
+"description": "Optional. The list of Issue fields to update. Currently only \"state\" is mutable.",
+"format": "google-fieldmask",
+"type": "string"
+}
+},
+"type": "object"
+},
+"User": {
+"description": "Developer-provided end user identifiers.",
+"id": "User",
+"properties": {
+"id": {
+"description": "User id if provided by the app developer.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"Version": {
+"description": "Application software version.",
+"id": "Version",
+"properties": {
+"buildVersion": {
+"description": "Mobile only. One display_version can have many build_version. On Android, strictly the same as \"version code\". On iOS, strictly the same as \"build number\" or CFBundleVersion.",
+"type": "string"
+},
+"displayName": {
+"description": "Compound readable string containing both display and build versions. Format: \"display_version (build_version)\" e.g. \"1.2.3 (456)\". This string can be used for filtering with the VersionFilter.display_name field.",
+"type": "string"
+},
+"displayVersion": {
+"description": "Readable version string, e.g. \"1.2.3\". On Android, strictly the same as \"version name\". On iOS, strictly the same as \"version number\" or CFBundleShortVersionString.",
+"type": "string"
+},
+"tracks": {
+"description": "Indicates releases which have artifacts that are currently available in the Play Store to the target audience of the track. Versions may be available in multiple tracks.",
+"items": {
+"$ref": "PlayTrack"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"WebMetricsGroup": {
+"description": "Represents a grouping for metrics specific to web applications.",
+"id": "WebMetricsGroup",
+"properties": {
+"id": {
+"description": "The id of the web metrics group",
+"type": "string"
+}
+},
+"type": "object"
+}
+},
+"servicePath": "",
+"title": "Firebase Crashlytics API",
+"version": "v1alpha",
+"version_module": true
+}
\ No newline at end of file
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json
index c24234385e..a41483bb7f 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json
@@ -2596,7 +2596,7 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260706",
 "rootUrl": "https://gkehub.googleapis.com/",
 "schemas": {
 "AppDevExperienceFeatureSpec": {
@@ -6840,7 +6840,7 @@
 ],
 "enumDescriptions": [
 "The default value.",
-"A standard rollout.",
+"A standard rollout for the whole sequence.",
 "A mandatory upgrade for clusters that haven't been patched within the allowed window.",
 "A mandatory upgrade for clusters that have reached its end of support."
 ],
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
index 9c94048b0f..dcc44ea47d 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json
@@ -2740,7 +2740,7 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260706",
 "rootUrl": "https://gkehub.googleapis.com/",
 "schemas": {
 "AppDevExperienceFeatureSpec": {
@@ -7357,7 +7357,7 @@
 ],
 "enumDescriptions": [
 "The default value.",
-"A standard rollout.",
+"A standard rollout for the whole sequence.",
 "A mandatory upgrade for clusters that haven't been patched within the allowed window.",
 "A mandatory upgrade for clusters that have reached its end of support."
 ],
diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
index d410457b39..c81ca8c19b 100644
--- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json
@@ -2596,7 +2596,7 @@
 }
 }
 },
-"revision": "20260623",
+"revision": "20260706",
 "rootUrl": "https://gkehub.googleapis.com/",
 "schemas": {
 "AppDevExperienceFeatureSpec": {
@@ -6966,7 +6966,7 @@
 ],
 "enumDescriptions": [
 "The default value.",
-"A standard rollout.",
+"A standard rollout for the whole sequence.",
 "A mandatory upgrade for clusters that haven't been patched within the allowed window.",
 "A mandatory upgrade for clusters that have reached its end of support."
 ],
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index 416184fdff..2954a15900 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -4257,7 +4257,7 @@
 }
 }
 },
-"revision": "20260320",
+"revision": "20260702",
 "rootUrl": "https://iam.googleapis.com/",
 "schemas": {
 "AccessRestrictions": {
@@ -5926,7 +5926,7 @@ false
 "type": "object"
 },
 "ServiceAccountKey": {
-"description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.",
+"description": "Represents a service account key. A service account has two sets of key-pairs: user-managed and system-managed. System-managed keys are also called _Google-owned and managed keys_. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys that are actively used for signing are rotated regularly according to [security best practices](https://docs.cloud.google.com/iam/docs/key-rotation#timing). The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.",
 "id": "ServiceAccountKey",
 "properties": {
 "disableReason": {
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json
index 1aa29dca8f..3dd849abae 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json
@@ -110,7 +110,7 @@
 "aggregateProductStatuses": {
 "methods": {
 "list": {
-"description": "Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.",
+"description": "Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.",
 "flatPath": "issueresolution/v1/accounts/{accountsId}/aggregateProductStatuses",
 "httpMethod": "GET",
 "id": "merchantapi.accounts.aggregateProductStatuses.list",
@@ -135,7 +135,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The account to list aggregate product statuses for. Format: `accounts/{account}`",
+"description": "Required. The account to list aggregate product statuses for. Format: `accounts/{account}` Can only be sub-accounts and standalone accounts.",
 "location": "path",
 "pattern": "^accounts/[^/]+$",
 "required": true,
@@ -268,7 +268,7 @@
 }
 }
 },
-"revision": "20260527",
+"revision": "20260707",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Action": {
diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json
index a9e27b3dfa..8fa83b5985 100644
--- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json
+++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1beta.json
@@ -110,7 +110,7 @@
 "aggregateProductStatuses": {
 "methods": {
 "list": {
-"description": "Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results.",
+"description": "Lists the `AggregateProductStatuses` resources for your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. This method can only be accessed by standalone accounts and sub-accounts of an advanced account. To retrieve product statuses for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.aggregateProductStatuses.list` for each sub-account individually.",
 "flatPath": "issueresolution/v1beta/accounts/{accountsId}/aggregateProductStatuses",
 "httpMethod": "GET",
 "id": "merchantapi.accounts.aggregateProductStatuses.list",
@@ -135,7 +135,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The account to list aggregate product statuses for. Format: `accounts/{account}`",
+"description": "Required. The account to list aggregate product statuses for. Format: `accounts/{account}` Can only be sub-accounts and standalone accounts.",
 "location": "path",
 "pattern": "^accounts/[^/]+$",
 "required": true,
@@ -268,7 +268,7 @@
 }
 }
 },
-"revision": "20260527",
+"revision": "20260707",
 "rootUrl": "https://merchantapi.googleapis.com/",
 "schemas": {
 "Action": {
diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json
index 3dae7d2e79..3e69bf19ac 100644
--- a/googleapiclient/discovery_cache/documents/monitoring.v1.json
+++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json
@@ -753,7 +753,7 @@
 }
 }
 },
-"revision": "20260611",
+"revision": "20260705",
 "rootUrl": "https://monitoring.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -1462,7 +1462,9 @@
 "SAP_AVAILABILITY",
 "SAP_OPERATIONS",
 "INTERCONNECT_MAINTENANCE_STARTED",
-"INTERCONNECT_MAINTENANCE_COMPLETED"
+"INTERCONNECT_MAINTENANCE_COMPLETED",
+"VPN_TRAFFIC_SELECTOR_NARROWING",
+"VPN_MAINTENANCE"
 ],
 "enumDescriptions": [
 "No event type specified.",
@@ -1491,7 +1493,9 @@
 "Agent for SAP availability related events.",
 "Agent for SAP operations related events.",
 "Interconnect maintenance started event.",
-"Interconnect maintenance completed event."
+"Interconnect maintenance completed event.",
+"VPN traffic selector narrowing event.",
+"VPN maintenance event."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json
index 0ae2c88800..171e945ae7 100644
--- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json
+++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json
@@ -166,7 +166,7 @@
 "type": "string"
 },
 "parent": {
-"description": "Required. The name of the account to fetch locations from. If the parent Account is of AccountType PERSONAL, only Locations that are directly owned by the Account are returned, otherwise it will return all accessible locations from the Account, either directly or indirectly.",
+"description": "Required. The name of the account to fetch locations from. * **Specific Account ID**: If the account is of type `AccountType.PERSONAL`, the response returns only locations directly owned by that account. For all other types (e.g., `AccountType.LOCATION_GROUP`), it returns all accessible locations. * **Wildcard (`-`)**: Using `accounts/-` identifies the authenticated user. This scope defaults to `AccountType.PERSONAL` but includes both directly and indirectly owned locations (e.g., those accessible via member groups).",
 "location": "path",
 "pattern": "^accounts/[^/]+$",
 "required": true,
@@ -612,7 +612,7 @@
 }
 }
 },
-"revision": "20260426",
+"revision": "20260707",
 "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/",
 "schemas": {
 "AdWordsLocationExtensions": {
diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
index 683b648ceb..12161dec12 100644
--- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json
@@ -1127,7 +1127,7 @@
 }
 }
 },
-"revision": "20260529",
+"revision": "20260701",
 "rootUrl": "https://networkconnectivity.googleapis.com/",
 "schemas": {
 "AllocationOptions": {
@@ -1514,12 +1514,16 @@
 "enum": [
 "RANGE_STATUS_UNSPECIFIED",
 "ACTIVE",
-"OBSOLETE"
+"OBSOLETE",
+"CREATING",
+"DELETING"
 ],
 "enumDescriptions": [
 "Unspecified status is the default value for an Internal Range.",
 "Ranges with ACTIVE status will reserve the CIDR block from the given VPC.",
-"A range becomes OBSOLETE if its VPC network is deleted. An OBSOLETE range is inactive, doesn't reserve any CIDR blocks, and can only be deleted or have its labels and description updated."
+"A range becomes OBSOLETE if its VPC network is deleted. An OBSOLETE range is inactive, doesn't reserve any CIDR blocks, and can only be deleted or have its labels and description updated.",
+"Ranges with CREATING state are in the process of being created.",
+"Ranges with DELETING state are in the process of being deleted."
 ],
 "readOnly": true,
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
index 986487ce49..f9979a9fe9 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1.json
@@ -6131,7 +6131,7 @@
 }
 }
 },
-"revision": "20260617",
+"revision": "20260707",
 "rootUrl": "https://networksecurity.googleapis.com/",
 "schemas": {
 "AddAddressGroupItemsRequest": {
@@ -6476,7 +6476,7 @@
 "type": "array"
 },
 "principals": {
-"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.",
+"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers.",
 "items": {
 "$ref": "AuthzPolicyAuthzRulePrincipal"
 },
@@ -6543,7 +6543,7 @@
 "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.",
 "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.",
 "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.",
-"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
+"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers and not for Classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
 ],
 "type": "string"
 }
@@ -9571,7 +9571,7 @@
 "type": "string"
 },
 "dataPathId": {
-"description": "Output only. Identifier used by the data-path. Unique within {container, location}.",
+"description": "Output only. Identifier used by the data-path. Unique within `{container, location}`.",
 "format": "uint64",
 "readOnly": true,
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
index 9838a724ed..3a7238acc3 100644
--- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json
@@ -6331,7 +6331,7 @@
 }
 }
 },
-"revision": "20260617",
+"revision": "20260707",
 "rootUrl": "https://networksecurity.googleapis.com/",
 "schemas": {
 "AddAddressGroupItemsRequest": {
@@ -6676,7 +6676,7 @@
 "type": "array"
 },
 "principals": {
-"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh. This field is not supported for global external Application Load Balancers.",
+"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless frontend mutual TLS is enabled for the forwarding rule or Gateway and the client certificate has been successfully validated by mTLS. Each identity is a string whose value is matched against a list of URI SANs, DNS Name SANs, or the common name in the client's certificate. A match happens when any principal matches with the rule. Limited to 50 principals per Authorization Policy for regional internal Application Load Balancers, regional external Application Load Balancers, cross-region internal Application Load Balancers, and Cloud Service Mesh while 25 principals per Authorization Policy for global external Application Load Balancers.",
 "items": {
 "$ref": "AuthzPolicyAuthzRulePrincipal"
 },
@@ -6743,7 +6743,7 @@
 "Unspecified principal selector. It will be treated as CLIENT_CERT_URI_SAN by default.",
 "The principal rule is matched against a list of URI SANs in the validated client's certificate. A match happens when there is any exact URI SAN value match. This is the default principal selector.",
 "The principal rule is matched against a list of DNS Name SANs in the validated client's certificate. A match happens when there is any exact DNS Name SAN value match. This is only applicable for Application Load Balancers except for classic Global External Application load balancer. CLIENT_CERT_DNS_NAME_SAN is not supported for INTERNAL_SELF_MANAGED load balancing scheme.",
-"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers except for global external Application Load Balancer and classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
+"The principal rule is matched against the common name in the client's certificate. Authorization against multiple common names in the client certificate is not supported. Requests with multiple common names in the client certificate will be rejected if CLIENT_CERT_COMMON_NAME is set as the principal selector. A match happens when there is an exact common name value match. This is only applicable for Application Load Balancers and not for Classic Application Load Balancer. CLIENT_CERT_COMMON_NAME is not supported for INTERNAL_SELF_MANAGED load balancing scheme."
 ],
 "type": "string"
 }
@@ -10035,7 +10035,7 @@
 "type": "string"
 },
 "dataPathId": {
-"description": "Output only. Identifier used by the data-path. Unique within {container, location}.",
+"description": "Output only. Identifier used by the data-path. Unique within `{container, location}`.",
 "format": "uint64",
 "readOnly": true,
 "type": "string"
diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
index 8a84051c42..c203f3a712 100644
--- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
+++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json
@@ -344,7 +344,7 @@
 }
 }
 },
-"revision": "20260622",
+"revision": "20260706",
 "rootUrl": "https://ondemandscanning.googleapis.com/",
 "schemas": {
 "AISkillAnalysisOccurrence": {
@@ -1486,13 +1486,15 @@
 "SCANNER_UNSPECIFIED",
 "STATIC",
 "LLM",
-"WS_POLICY"
+"WS_POLICY",
+"GOOGLE_ANTIVIRUS"
 ],
 "enumDescriptions": [
 "Unspecified scanner.",
 "Static scanner.",
 "LLM scanner.",
-"WS_POLICY scanner."
+"WS_POLICY scanner.",
+"Google AntiVirus Service scanner."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
index 5788d3ae4b..f4cc7eef48 100644
--- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json
@@ -344,7 +344,7 @@
 }
 }
 },
-"revision": "20260622",
+"revision": "20260706",
 "rootUrl": "https://ondemandscanning.googleapis.com/",
 "schemas": {
 "AISkillAnalysisOccurrence": {
@@ -1481,13 +1481,15 @@
 "SCANNER_UNSPECIFIED",
 "STATIC",
 "LLM",
-"WS_POLICY"
+"WS_POLICY",
+"GOOGLE_ANTIVIRUS"
 ],
 "enumDescriptions": [
 "Unspecified scanner.",
 "Static scanner.",
 "LLM scanner.",
-"WS_POLICY scanner."
+"WS_POLICY scanner.",
+"Google AntiVirus Service scanner."
 ],
 "type": "string"
 },
diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json
index c8002e0a4a..39bd248a02 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1.json
@@ -1845,7 +1845,7 @@
 }
 }
 },
-"revision": "20260616",
+"revision": "20260707",
 "rootUrl": "https://redis.googleapis.com/",
 "schemas": {
 "AOFConfig": {
@@ -3284,7 +3284,8 @@
 "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDeprecated": [
 false,
@@ -3395,6 +3396,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3506,7 +3508,8 @@ false
 "Change in performance KPIs.",
 "Database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 },
@@ -3560,7 +3563,7 @@ false
 "type": "string"
 },
 "resourceType": {
-"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel",
+"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel",
 "type": "string"
 },
 "uniqueId": {
@@ -4019,7 +4022,8 @@ false
 "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDeprecated": [
 false,
@@ -4130,6 +4134,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4241,7 +4246,8 @@ false
 "Change in performance KPIs.",
 "Database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
index ac043fd367..8bae44cab4 100644
--- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json
@@ -1841,7 +1841,7 @@
 }
 }
 },
-"revision": "20260616",
+"revision": "20260707",
 "rootUrl": "https://redis.googleapis.com/",
 "schemas": {
 "AOFConfig": {
@@ -3280,7 +3280,8 @@
 "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDeprecated": [
 false,
@@ -3391,6 +3392,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3502,7 +3504,8 @@ false
 "Change in performance KPIs.",
 "Database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 },
@@ -3556,7 +3559,7 @@ false
 "type": "string"
 },
 "resourceType": {
-"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel",
+"description": "Required. The type of resource this ID is identifying. Ex go/keep-sorted start alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance compute.googleapis.com/Instance firestore.googleapis.com/Database, memorystore.googleapis.com/Instance, redis.googleapis.com/Instance, redis.googleapis.com/Cluster, oracledatabase.googleapis.com/CloudExadataInfrastructure oracledatabase.googleapis.com/CloudVmCluster oracledatabase.googleapis.com/AutonomousDatabase spanner.googleapis.com/Instance, spanner.googleapis.com/Database, sqladmin.googleapis.com/Instance, go/keep-sorted end REQUIRED Please refer go/condor-common-datamodel",
 "type": "string"
 },
 "uniqueId": {
@@ -4015,7 +4018,8 @@ false
 "SIGNAL_TYPE_PERFORMANCE_KPI_CHANGE",
 "SIGNAL_TYPE_VERSION_NEARING_END_OF_LIFE",
 "SIGNAL_TYPE_HIGH_MAINTENANCE_DOWNTIME_RISK",
-"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME"
+"SIGNAL_TYPE_LOW_CACHE_HIT_AND_MAINTENANCE_DOWNTIME",
+"SIGNAL_TYPE_MISSING_ENHANCED_PROTECTION"
 ],
 "enumDeprecated": [
 false,
@@ -4126,6 +4130,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4237,7 +4242,8 @@ false
 "Change in performance KPIs.",
 "Database version nearing end of life.",
 "Indicates a high risk of maintenance downtime.",
-"Indicates both a low cache hit rate and a risk of maintenance downtime."
+"Indicates both a low cache hit rate and a risk of maintenance downtime.",
+"Indicates that the resource is missing enhanced protection."
 ],
 "type": "string"
 }
diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json
index 6a8d19e700..c9c7a39c91 100644
--- a/googleapiclient/discovery_cache/documents/sts.v1.json
+++ b/googleapiclient/discovery_cache/documents/sts.v1.json
@@ -342,7 +342,7 @@
 "openid": {
 "methods": {
 "getJwks": {
-"description": "Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.",
+"description": "Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available \"as is\" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).",
 "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/openid/jwks",
 "httpMethod": "GET",
 "id": "sts.organizations.locations.workloadIdentityPools.openid.getJwks",
@@ -368,7 +368,7 @@
 "well-known": {
 "methods": {
 "getOpenid-configuration": {
-"description": "Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.",
+"description": "Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available \"as is\" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).",
 "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/.well-known/openid-configuration",
 "httpMethod": "GET",
 "id": "sts.organizations.locations.workloadIdentityPools.well-known.getOpenid-configuration",
@@ -406,7 +406,7 @@
 "openid": {
 "methods": {
 "getJwks": {
-"description": "Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported.",
+"description": "Fetches the signing keys for an agentic or managed workload identity pool and returns them in JWKs format, defined in [RFC 7517](https://tools.ietf.org/html/rfc7517). For now, only agentic system pools are supported. **Preview** This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available \"as is\" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/openid/jwks",
 "httpMethod": "GET",
 "id": "sts.projects.locations.workloadIdentityPools.openid.getJwks",
@@ -432,7 +432,7 @@
 "well-known": {
 "methods": {
 "getOpenid-configuration": {
-"description": "Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported.",
+"description": "Gets the OIDC provider configuration for an agentic or managed workload identity pool following [the OIDC 1.0 discovery specification](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationResponse). For now, only agentic system pools are supported. **Preview** This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section of the [Service Specific Terms](https://cloud.google.com/terms/service-terms#1). Pre-GA features are available \"as is\" and might have limited support. For more information, see the [launch stage descriptions](https://cloud.google.com/products#product-launch-stages).",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workloadIdentityPools/{workloadIdentityPoolsId}/.well-known/openid-configuration",
 "httpMethod": "GET",
 "id": "sts.projects.locations.workloadIdentityPools.well-known.getOpenid-configuration",
@@ -481,7 +481,7 @@
 }
 }
 },
-"revision": "20260618",
+"revision": "20260701",
 "rootUrl": "https://sts.googleapis.com/",
 "schemas": {
 "GoogleIamV1Binding": {